• management
• SDK
• TokenExchangeProfilesClient

Class TokenExchangeProfilesClient

Index

Constructors

constructor

Methods

listcreategetdeleteupdate

Properties

_options

Constructors

constructor

new TokenExchangeProfilesClient(
options: BaseClientOptions,
): TokenExchangeProfilesClient

Parameters

• options: BaseClientOptions

Returns TokenExchangeProfilesClient

Methods

list

list(
request?: TokenExchangeProfilesListRequest,
requestOptions?: TokenExchangeProfilesClient.RequestOptions,
): Promise<
Page<
TokenExchangeProfileResponseContent,
ListTokenExchangeProfileResponseContent,
>,
>

Retrieve a list of all Token Exchange Profiles available in your tenant.

By using this feature, you agree to the applicable Free Trial terms in Okta’s Master Subscription Agreement. It is your responsibility to securely validate the user’s subject_token. See User Guide for more details.

This endpoint supports Checkpoint pagination. To search by checkpoint, use the following parameters:

• from: Optional id from which to start selection.
• take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.

Note : The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.

Parameters

• request: TokenExchangeProfilesListRequest = {}
• OptionalrequestOptions: TokenExchangeProfilesClient.RequestOptions

Request-specific configuration.

Returns Promise< Page< TokenExchangeProfileResponseContent, ListTokenExchangeProfileResponseContent, >, >

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.tokenExchangeProfiles.list({ from: "from", take: 1 })Copy

create

create(
request: CreateTokenExchangeProfileRequestContent,
requestOptions?: TokenExchangeProfilesClient.RequestOptions,
): HttpResponsePromise<CreateTokenExchangeProfileResponseContent>

Create a new Token Exchange Profile within your tenant.

By using this feature, you agree to the applicable Free Trial terms in Okta’s Master Subscription Agreement. It is your responsibility to securely validate the user’s subject_token. See User Guide for more details.

Parameters

• request: CreateTokenExchangeProfileRequestContent
• OptionalrequestOptions: TokenExchangeProfilesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<CreateTokenExchangeProfileResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.ConflictError

Throws

Management.TooManyRequestsError

Example

await client.tokenExchangeProfiles.create({ name: "name", subject_token_type: "subject_token_type", action_id: "action_id", type: "custom_authentication" })Copy

get

get(
id: string,
requestOptions?: TokenExchangeProfilesClient.RequestOptions,
): HttpResponsePromise<GetTokenExchangeProfileResponseContent>

Retrieve details about a single Token Exchange Profile specified by ID.

By using this feature, you agree to the applicable Free Trial terms in Okta’s Master Subscription Agreement. It is your responsibility to securely validate the user’s subject_token. See User Guide for more details.

Parameters

• id: string

ID of the Token Exchange Profile to retrieve.

• OptionalrequestOptions: TokenExchangeProfilesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetTokenExchangeProfileResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.tokenExchangeProfiles.get("id")Copy

delete

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

Delete a Token Exchange Profile within your tenant.

By using this feature, you agree to the applicable Free Trial terms in Okta's Master Subscription Agreement. It is your responsibility to securely validate the user's subject_token. See User Guide for more details.

Parameters

• id: string

ID of the Token Exchange Profile to delete.

• OptionalrequestOptions: TokenExchangeProfilesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

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

update

update(
id: string,
request?: UpdateTokenExchangeProfileRequestContent,
requestOptions?: TokenExchangeProfilesClient.RequestOptions,
): HttpResponsePromise<void>

Update a Token Exchange Profile within your tenant.

By using this feature, you agree to the applicable Free Trial terms in Okta's Master Subscription Agreement. It is your responsibility to securely validate the user's subject_token. See User Guide for more details.

Parameters

• id: string

ID of the Token Exchange Profile to update.

• request: UpdateTokenExchangeProfileRequestContent = {}
• OptionalrequestOptions: TokenExchangeProfilesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.tokenExchangeProfiles.update("id")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listcreategetdeleteupdate Properties _options