Skip to main content
GET
/
details
TypeScript
import { MyOrganizationClient } from "github.com/auth0/myorganization-js";

async function main() {
    const client = new MyOrganizationClient({
        token: "<token>",
    });
    await client.organizationDetails.get();
}
main();
{
  "id": "org_zW1UHutvkVWSWdCC",
  "name": "testorg",
  "display_name": "Test Organization",
  "branding": {
    "logo_url": "https://example.com/logo.png",
    "colors": {
      "primary": "#000000",
      "page_background": "#FFFFFF"
    }
  }
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Response

Organization details successfully retrieved.

id
string

Organization identifier.

Pattern: ^org_[A-Za-z0-9]{16}$
name
string

The name of this organization.

Required string length: 1 - 50
display_name
string

Friendly name of this organization.

Required string length: 1 - 255
branding
object

Theme defines how to style the login pages.