Back to Node Auth0

Class ClientGrantsClient

docs/classes/management.SDK.ClientGrantsClient-1.html

5.9.16.1 KB
Original Source

Class ClientGrantsClient

Index

Constructors

constructor

Methods

listcreatedelete

Properties

_options

Constructors

constructor

new ClientGrantsClient(options: BaseClientOptions): ClientGrantsClient

Parameters

Returns ClientGrantsClient

Methods

list

list(
id: string,
request?: ListOrganizationClientGrantsRequestParameters,
requestOptions?: ClientGrantsClient.RequestOptions,
): Promise<
Page<
OrganizationClientGrant,
ListOrganizationClientGrantsOffsetPaginatedResponseContent,
>,
>

Parameters

  • id: string

Organization identifier.

Request-specific configuration.

Returns Promise< Page< OrganizationClientGrant, ListOrganizationClientGrantsOffsetPaginatedResponseContent, >, >

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.organizations.clientGrants.list("id", { audience: "audience", client_id: "client_id", grant_ids: ["grant_ids"], page: 1, per_page: 1, include_totals: true })Copy

create

create(
id: string,
request: AssociateOrganizationClientGrantRequestContent,
requestOptions?: ClientGrantsClient.RequestOptions,
): HttpResponsePromise<AssociateOrganizationClientGrantResponseContent>

Parameters

  • id: string

Organization identifier.

Request-specific configuration.

Returns HttpResponsePromise<AssociateOrganizationClientGrantResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.ConflictError

Throws

Management.TooManyRequestsError

Example

await client.organizations.clientGrants.create("id", { grant_id: "grant_id" })Copy

delete

delete(
id: string,
grant_id: string,
requestOptions?: ClientGrantsClient.RequestOptions,
): HttpResponsePromise<void>

Parameters

  • id: string

Organization identifier.

  • grant_id: string

The Client Grant ID to remove from the organization

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.organizations.clientGrants.delete("id", "grant_id")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listcreatedelete Properties _options