List user's organizations

Retrieve list of the specified user’s current Organization memberships. User must be specified by user ID. For more information, review Auth0 Organizations.

This endpoint supports two types of pagination:

• Offset pagination
• Checkpoint pagination

Checkpoint pagination must be used if you need to retrieve more than 1000 organizations.

Checkpoint Pagination

To search by checkpoint, use the following parameters:

• from: Optional id from which to start selection.
• take: The total number of entries to retrieve when using the from parameter. Defaults to 50.

Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.

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

C#

C#

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

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.Users.Organizations.ListAsync(
            id: "id",
            request: new ListUserOrganizationsRequestParameters {
                Page = 1,
                PerPage = 1,
                IncludeTotals = true
            }
        );
    }

}

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
      }
    },
    "third_party_client_access": "block",
    "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 user to retrieve the organizations for.

Query Parameters

page · integer

Page index of the results to return. First page is 0.

Required range: 0 <= x <= 1000

per_page · integer

Number of results per page. Defaults to 50.

Required range: 1 <= x <= 100

include_totals · boolean

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

from · string

Optional Id from which to start selection.

take · integer

Number of results per page. Defaults to 50.

Required range: 1 <= x <= 100

Response

200

application/json

Organizations successfully retrieved.

Option 1 · object[]

Option 2 · object

Option 3 · object

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