Get organization

Retrieve details about a single Organization specified by ID.

GET https://{tenantDomain}/api/v2/organizations/{id}

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Organizations.GetAsync(
            "id"
        );
    }

}

package example

import (
    context "context"

    client "github.com/auth0/go-auth0/v2/management/client"
    option "github.com/auth0/go-auth0/v2/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    mgmt.Organizations.Get(
        context.TODO(),
        "id",
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.organizations().get("id");
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->organizations->get(
    'id',
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.organizations.get(
    id="id",
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.organizations.get(id: "id")

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.get("id");
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.get("id");
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/organizations/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "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
    }
  },
  "is_app_entitlement_active": true,
  "client": {
    "use_for_member_access": true
  }
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

id · string · required

ID of the organization to retrieve.

Response

200

application/json

Organization successfully retrieved.

id · string<organization-id>

Organization identifier.

Maximum string length: 50

name · string<organization-name> · default: organization-1

The name of this organization.

Required string length: 1 - 50

display_name · string · default: Acme Users

Friendly name of this organization.

Required string length: 1 - 255

branding · object

Theme defines how to style the login pages.

Show child attributes

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.

Show child attributes

token_quota · object · EA

Show child attributes

third_party_client_access · enum<string> · GA

Controls whether this organization can be used in user flows with third-party clients. Defaults to block.

Available options: block, allow

is_app_entitlement_active · boolean · EA

Whether app entitlement is active for this organization.

client · object · EA

The organization's association with the client passed in the include_client_association_for query parameter.

Show child attributes