Class TokenExchangeProfiles

Index

Constructors

constructor

new TokenExchangeProfiles(
_options: TokenExchangeProfiles.Options,
): TokenExchangeProfiles
Parameters
- _options: TokenExchangeProfiles.Options
Returns TokenExchangeProfiles

Methods

list

list(
request?: Management.TokenExchangeProfilesListRequest,
requestOptions?: TokenExchangeProfiles.RequestOptions,
): Promise<Page<TokenExchangeProfileResponseContent>>
Retrieve a list of all Token Exchange Profiles available in your tenant.

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: Management.TokenExchangeProfilesListRequest = {}
- OptionalrequestOptions: TokenExchangeProfiles.RequestOptions
  Request-specific configuration.
Returns Promise<Page<TokenExchangeProfileResponseContent>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.tokenExchangeProfiles.list()
```

create

create(
request: Management.CreateTokenExchangeProfileRequestContent,
requestOptions?: TokenExchangeProfiles.RequestOptions,
): HttpResponsePromise<CreateTokenExchangeProfileResponseContent>
Create a new Token Exchange Profile within your tenant.
Parameters
- request: Management.CreateTokenExchangeProfileRequestContent
- OptionalrequestOptions: TokenExchangeProfiles.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"
    })
```

get

get(
id: string,
requestOptions?: TokenExchangeProfiles.RequestOptions,
): HttpResponsePromise<GetTokenExchangeProfileResponseContent>
Retrieve details about a single Token Exchange Profile specified by ID.
Parameters
- id: string
  ID of the Token Exchange Profile to retrieve.
- OptionalrequestOptions: TokenExchangeProfiles.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")
```

delete

delete(
id: string,
requestOptions?: TokenExchangeProfiles.RequestOptions,
): HttpResponsePromise<void>
Delete a Token Exchange Profile within your tenant.
Parameters
- id: string
  ID of the Token Exchange Profile to delete.
- OptionalrequestOptions: TokenExchangeProfiles.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.tokenExchangeProfiles.delete("id")
```

update

update(
    id: string,
    request?: Management.UpdateTokenExchangeProfileRequestContent,
    requestOptions?: TokenExchangeProfiles.RequestOptions,
): HttpResponsePromise<void>
Update a Token Exchange Profile within your tenant.
Parameters
- id: string
  ID of the Token Exchange Profile to update.
- request: Management.UpdateTokenExchangeProfileRequestContent = {}
- OptionalrequestOptions: TokenExchangeProfiles.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")
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: TokenExchangeProfiles.Options

Class TokenExchangeProfiles

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns TokenExchangeProfiles

Methods

list

Parameters

Returns Promise<Page<TokenExchangeProfileResponseContent>>

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateTokenExchangeProfileResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetTokenExchangeProfileResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Example

Protected_getAuthorizationHeader

Returns Promise<string>

Properties

Protected Readonly_options

Settings

On This Page

`Protected`_getAuthorizationHeader

`Protected` `Readonly`_options