Back to Node Auth0

Class TokensClient

docs/classes/management.SDK.TokensClient.html

5.9.14.6 KB
Original Source

Class TokensClient

Index

Constructors

constructor

Methods

getcreatedelete

Properties

_options

Constructors

constructor

new TokensClient(options: BaseClientOptions): TokensClient

Parameters

Returns TokensClient

Methods

get

get(
id: string,
requestOptions?: TokensClient.RequestOptions,
): HttpResponsePromise<GetScimTokensResponseContent>

Retrieves all scim tokens by its connection id.

Parameters

  • id: string

The id of the connection to retrieve its SCIM configuration

Request-specific configuration.

Returns HttpResponsePromise<GetScimTokensResponseContent>

Throws

Management.BadRequestError

Throws

Management.NotFoundError

Example

await client.connections.scimConfiguration.tokens.get("id")Copy

create

create(
id: string,
request?: CreateScimTokenRequestContent,
requestOptions?: TokensClient.RequestOptions,
): HttpResponsePromise<CreateScimTokenResponseContent>

Create a scim token for a scim client.

Parameters

  • id: string

The id of the connection to create its SCIM token

Request-specific configuration.

Returns HttpResponsePromise<CreateScimTokenResponseContent>

Throws

Management.BadRequestError

Throws

Management.NotFoundError

Throws

Management.ConflictError

Example

await client.connections.scimConfiguration.tokens.create("id")Copy

delete

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

Deletes a scim token by its connection id and tokenId.

Parameters

  • id: string

The connection id that owns the SCIM token to delete

  • tokenId: string

The id of the scim token to delete

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.NotFoundError

Example

await client.connections.scimConfiguration.tokens.delete("id", "tokenId")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods getcreatedelete Properties _options