Organizations

organizations

Methods

Create An Organization -> { id, branding, display_name, 3 more... }
post/organizations

Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review Create Your First Organization.

Delete Organization ->
delete/organizations/{id}

Remove an Organization from your tenant. This action cannot be undone.

Note: Members are automatically disassociated from an Organization when it is deleted. However, this action does not delete these users from your tenant.

Get Organizations -> OrganizationsPageNumberPage<{ id, branding, display_name, 2 more... }>
get/organizations

Retrieve detailed list of all Organizations available in your tenant. For more information, see 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 Organization -> { id, branding, display_name, 2 more... }
get/organizations/{id}

Retrieve details about a single Organization specified by ID.

Modify An Organization -> { id, branding, display_name, 2 more... }
patch/organizations/{id}

Update the details of a specific Organization, such as name and display name, branding options, and metadata.

Organizations

Client Grants

organizations.client_grants

Methods

Associate A Client Grant With An Organization -> { id, allow_any_organization, audience, 3 more... }
post/organizations/{id}/client-grants

Associate a client grant with an organization

Remove A Client Grant From An Organization ->
delete/organizations/{id}/client-grants/{grant_id}

Remove a client grant from an organization

Get Client Grants Associated To An Organization -> ClientGrantsPageNumberPage<{ id, allow_any_organization, audience, 3 more... }>
get/organizations/{id}/client-grants

Get client grants associated to an organization

Organizations

Enabled Connections

organizations.enabled_connections

Methods

Add Connections To An Organization -> { assign_membership_on_login, connection, connection_id, 2 more... }
post/organizations/{id}/enabled_connections

Enable a specific connection for a given Organization. To enable a connection, it must already exist within your tenant; connections cannot be created through this action.

Connections represent the relationship between Auth0 and a source of users. Available types of connections include database, enterprise, and social.

Delete Connections From An Organization ->
delete/organizations/{id}/enabled_connections/{connectionId}

Disable a specific connection for an Organization. Once disabled, Organization members can no longer use that connection to authenticate.

Note: This action does not remove the connection from your tenant.

Get Connections Enabled For An Organization -> OrganizationsEnabledConnectionsPageNumberPage<{ assign_membership_on_login, connection, connection_id, 2 more... }>
get/organizations/{id}/enabled_connections

Retrieve details about a specific connection currently enabled for an Organization. Information returned includes details such as connection ID, name, strategy, and whether the connection automatically grants membership upon login.

Get An Enabled Connection For An Organization -> { assign_membership_on_login, connection, connection_id, 2 more... }
get/organizations/{id}/enabled_connections/{connectionId}

Retrieve details about a specific connection currently enabled for an Organization. Information returned includes details such as connection ID, name, strategy, and whether the connection automatically grants membership upon login.

Update The Connection Of An Organization -> { assign_membership_on_login, connection, connection_id, 2 more... }
patch/organizations/{id}/enabled_connections/{connectionId}

Modify the details of a specific connection currently enabled for an Organization.

Organizations

Invitations

organizations.invitations

Methods

Create Invitations To An Organization -> { id, app_metadata, client_id, 10 more... }
post/organizations/{id}/invitations

Create a user invitation for a specific Organization. Upon creation, the listed user receives an email inviting them to join the Organization. To learn more about Organization invitations, review Invite Organization Members.

Delete An Invitation To An Organization ->
delete/organizations/{id}/invitations/{invitation_id}

Delete an invitation to an Organization

Get Invitations To An Organization -> InvitationsPageNumberPage<{ id, app_metadata, client_id, 10 more... }>
get/organizations/{id}/invitations

Retrieve a detailed list of invitations sent to users for a specific Organization. The list includes details such as inviter and invitee information, invitation URLs, and dates of creation and expiration. To learn more about Organization invitations, review Invite Organization Members.

Get A Specific Invitation To An Organization -> { id, app_metadata, client_id, 10 more... }
get/organizations/{id}/invitations/{invitation_id}

Get a specific invitation to an Organization

organizations.members

Methods

Add Members To An Organization ->
post/organizations/{id}/members

Set one or more existing users as members of a specific Organization.

To add a user to an Organization through this action, the user must already exist in your tenant. If a user does not yet exist, you can invite them to create an account, manually create them through the Auth0 Dashboard, or use the Management API.

Delete Members From An Organization ->
delete/organizations/{id}/members

Delete members from an organization

Get Members Who Belong To An Organization -> OrganizationsMembersPageNumberPage<{ email, name, picture, 2 more... }>
get/organizations/{id}/members

List organization members. This endpoint is subject to eventual consistency. New users may not be immediately included in the response and deleted users may not be immediately removed from it.

  • Use the fields parameter to optionally define the specific member details retrieved. If fields is left blank, all fields (except roles) are returned.
  • Member roles are not sent by default. Use fields=roles to retrieve the roles assigned to each listed member. To use this parameter, you must include the read:organization_member_roles scope in the token.

This endpoint supports two types of pagination:

  • Offset pagination
  • Checkpoint pagination

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

Checkpoint Pagination

To search by checkpoint, use the following parameters: - from: Optional id from which to start selection. - take: The total amount of entries to retrieve when using the from parameter. Defaults to 50. Note: The first time you call this endpoint using Checkpoint Pagination, you should omit the from parameter. If there are more results, a next value will be included in the response. You can use this for subsequent API calls. When next is no longer included in the response, this indicates there are no more pages remaining.

organizations.members.roles

Methods

Assign User Roles To An Organization Member ->
post/organizations/{id}/members/{user_id}/roles

Assign one or more roles to a user to determine their access for a specific Organization.

Users can be members of multiple Organizations with unique roles assigned for each membership. This action assigns roles to a user only for the specified Organization. Roles cannot be assigned to a user across multiple Organizations in the same call.

Delete User Roles From An Organization Member ->
delete/organizations/{id}/members/{user_id}/roles

Remove one or more Organization-specific roles from a given user.

Users can be members of multiple Organizations with unique roles assigned for each membership. This action removes roles from a user in relation to the specified Organization. Roles assigned to the user within a different Organization cannot be managed in the same call.

Get User Roles Assigned To An Organization Member -> Array<{ id, description, name }> | { limit, roles, start, 1 more... }
get/organizations/{id}/members/{user_id}/roles

Retrieve detailed list of roles assigned to a given user within the context of a specific Organization.

Users can be members of multiple Organizations with unique roles assigned for each membership. This action only returns the roles associated with the specified Organization; any roles assigned to the user within other Organizations are not included.

organizations.name

Methods

Get Organization By Name -> { id, branding, display_name, 2 more... }
get/organizations/name/{name}

Retrieve details about a single Organization specified by name.