Class TokenExchangeProfilesClient

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

public class TokenExchangeProfilesClient : ITokenExchangeProfilesClient

Inheritance

object

TokenExchangeProfilesClient

Implements

ITokenExchangeProfilesClient

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

OptionalExtensions.AddIfNotNull<T>(T?, Dictionary<string, object?>, string)

Methods

CreateAsync(CreateTokenExchangeProfileRequestContent, RequestOptions?, CancellationToken)

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.

public WithRawResponseTask<CreateTokenExchangeProfileResponseContent> CreateAsync(CreateTokenExchangeProfileRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request CreateTokenExchangeProfileRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateTokenExchangeProfileResponseContent>

Examples

await client.TokenExchangeProfiles.CreateAsync(
    new CreateTokenExchangeProfileRequestContent
    {
        Name = "name",
        SubjectTokenType = "subject_token_type",
        ActionId = "action_id",
        Type = TokenExchangeProfileTypeEnum.CustomAuthentication,
    }
);

DeleteAsync(string, RequestOptions?, CancellationToken)

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.

public Task DeleteAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.TokenExchangeProfiles.DeleteAsync("id");

GetAsync(string, RequestOptions?, CancellationToken)

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.

public WithRawResponseTask<GetTokenExchangeProfileResponseContent> GetAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetTokenExchangeProfileResponseContent>

Examples

await client.TokenExchangeProfiles.GetAsync("id");

ListAsync(TokenExchangeProfilesListRequest, RequestOptions?, CancellationToken)

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.

public Task<Pager<TokenExchangeProfileResponseContent>> ListAsync(TokenExchangeProfilesListRequest request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request TokenExchangeProfilesListRequest

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<TokenExchangeProfileResponseContent>>

Examples

await client.TokenExchangeProfiles.ListAsync(
    new TokenExchangeProfilesListRequest { From = "from", Take = 1 }
);

UpdateAsync(string, UpdateTokenExchangeProfileRequestContent, RequestOptions?, CancellationToken)

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.

public Task UpdateAsync(string id, UpdateTokenExchangeProfileRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request UpdateTokenExchangeProfileRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.TokenExchangeProfiles.UpdateAsync(
    "id",
    new UpdateTokenExchangeProfileRequestContent()
);