Passer au contenu principal
GET
/
organizations
/
name
/
{name}
TypeScript
import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.getByName("name");
}
main();
{
  "id": "<string>",
  "name": "organization-1",
  "display_name": "Acme Users",
  "branding": {
    "logo_url": "<string>",
    "colors": {
      "primary": "<string>",
      "page_background": "<string>"
    }
  },
  "metadata": {},
  "token_quota": {
    "client_credentials": {
      "enforce": true,
      "per_day": 1073741824,
      "per_hour": 1073741824
    }
  }
}

Autorisations

Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

name
string
requis

name of the organization to retrieve.

Required string length: 1 - 50

Réponse

Organization successfully retrieved.

id
string<organization-id>

Organization identifier.

Maximum string length: 50
name
string<organization-name>
défaut:organization-1

The name of this organization.

Required string length: 1 - 50
display_name
string
défaut:Acme Users

Friendly name of this organization.

Required string length: 1 - 255
branding
object

Theme defines how to style the login pages.

metadata
object

Metadata associated with the organization, in the form of an object with string values (max 255 chars). Maximum of 25 metadata properties allowed.

token_quota
object