• management
• SDK
• OrganizationsClient

Class OrganizationsClient

Index

Constructors

constructor

Methods

list

Properties

_options

Constructors

constructor

new OrganizationsClient(options: BaseClientOptions): OrganizationsClient

Parameters

• options: BaseClientOptions

Returns OrganizationsClient

Methods

list

list(
id: string,
request?: ListUserOrganizationsRequestParameters,
requestOptions?: OrganizationsClient.RequestOptions,
): Promise<
Page<Organization, ListUserOrganizationsOffsetPaginatedResponseContent>,
>

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

Parameters

• id: string

ID of the user to retrieve the organizations for.

• request: ListUserOrganizationsRequestParameters = {}
• OptionalrequestOptions: OrganizationsClient.RequestOptions

Request-specific configuration.

Returns Promise<Page<Organization, ListUserOrganizationsOffsetPaginatedResponseContent>>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.users.organizations.list("id", { page: 1, per_page: 1, include_totals: true })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods list Properties _options