Back to Node Auth0

Class UserGrantsClient

docs/classes/management.SDK.UserGrantsClient.html

5.9.15.0 KB
Original Source

Class UserGrantsClient

Index

Constructors

constructor

Methods

listdeleteByUserIddelete

Properties

_options

Constructors

constructor

new UserGrantsClient(options: BaseClientOptions): UserGrantsClient

Parameters

Returns UserGrantsClient

Methods

list

list(
request?: ListUserGrantsRequestParameters,
requestOptions?: UserGrantsClient.RequestOptions,
): Promise<Page<UserGrant, ListUserGrantsOffsetPaginatedResponseContent>>

Retrieve the grants associated with your account.

Parameters

Request-specific configuration.

Returns Promise<Page<UserGrant, ListUserGrantsOffsetPaginatedResponseContent>>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.userGrants.list({ per_page: 1, page: 1, include_totals: true, user_id: "user_id", client_id: "client_id", audience: "audience" })Copy

deleteByUserId

deleteByUserId(
request: DeleteUserGrantByUserIdRequestParameters,
requestOptions?: UserGrantsClient.RequestOptions,
): HttpResponsePromise<void>

Delete a grant associated with your account.

Parameters

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.userGrants.deleteByUserId({ user_id: "user_id" })Copy

delete

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

Delete a grant associated with your account.

Parameters

  • id: string

ID of the grant to delete.

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.userGrants.delete("id")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listdeleteByUserIddelete Properties _options