Class TokensClient

Index

Constructors

Methods

get create delete

Properties

Constructors

constructor

new TokensClient(options: BaseClientOptions): TokensClient
Parameters
- options: BaseClientOptions
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
- OptionalrequestOptions: TokensClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetScimTokensResponseContent>
Throws
Management.BadRequestError

Throws
Management.NotFoundError
Example
```
await client.connections.scimConfiguration.tokens.get("id")
```

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: CreateScimTokenRequestContent = {}
- OptionalrequestOptions: TokensClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreateScimTokenResponseContent>
Throws
Management.BadRequestError

Throws
Management.NotFoundError

Throws
Management.ConflictError
Example
```
await client.connections.scimConfiguration.tokens.create("id")
```

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
- OptionalrequestOptions: TokensClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.NotFoundError
Example
```
await client.connections.scimConfiguration.tokens.delete("id", "tokenId")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>