Class TokenExchangeTokenRequest

Namespace

Auth0.AuthenticationApi.Models

Assembly

Auth0.AuthenticationApi.dll

Represents a request to exchange a token using the OAuth 2.0 Token Exchange grant (RFC 8693), also known as Custom Token Exchange.

public class TokenExchangeTokenRequest : IClientAuthentication

Inheritance

object

TokenExchangeTokenRequest

Implements

IClientAuthentication

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

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

Remarks

The same request covers both a normal access-token exchange (Phase 1) and an Auth0 Session Transfer Token exchange (Phase 2) — the latter by setting Audience to the session-transfer audience and supplying an actor token.

Properties

ActorToken

Optional token that represents the identity of the acting party. When supplied, ActorTokenType must also be supplied (both-or-neither).

public string ActorToken { get; set; }

Property Value

string

ActorTokenType

An identifier that indicates the type of ActorToken, as a URN. For an Auth0 ID token use IdToken. See TokenType for well-known values. Required if ActorToken is set; must be omitted otherwise.

public string ActorTokenType { get; set; }

Property Value

string

Audience

Optional target audience (API identifier) for the requested token. For a Session Transfer Token, set this to the session-transfer audience.

public string Audience { get; set; }

Property Value

string

ClientAssertionSecurityKey

Security Key to use with Client Assertion.

public SecurityKey ClientAssertionSecurityKey { get; set; }

Property Value

SecurityKey

ClientAssertionSecurityKeyAlgorithm

Algorithm for the Security Key to use with Client Assertion.

public string ClientAssertionSecurityKeyAlgorithm { get; set; }

Property Value

string

ClientId

Client ID of the application.

public string ClientId { get; set; }

Property Value

string

ClientSecret

Client Secret of the application.

public string ClientSecret { get; set; }

Property Value

string

Nonce

Optional nonce to validate against the nonce claim in a returned ID token.

public string? Nonce { get; set; }

Property Value

string

Remarks

When set, the nonce claim in the returned ID token must exactly match this value. Leave null (the default) to skip nonce validation.

Organization

Optional organization. Can be an Organization Name or ID.

public string Organization { get; set; }

Property Value

string

Scope

Optional space-delimited scopes for the requested token.

public string Scope { get; set; }

Property Value

string

SigningAlgorithm

What JwtSignatureAlgorithm is used to verify the signature of Id Tokens.

public JwtSignatureAlgorithm SigningAlgorithm { get; set; }

Property Value

JwtSignatureAlgorithm

SubjectToken

The token that represents the identity of the party on behalf of whom the request is being made. Required.

public string SubjectToken { get; set; }

Property Value

string

SubjectTokenType

Identifies the Custom Token Exchange Profile that validates the SubjectToken. Must be a URI under your own ownership (for example https://acme.com/cte-profile or urn:acme:legacy-token) and must correspond to an existing profile. Reserved namespaces such as urn:ietf, urn:auth0, and http://auth0.com are rejected. Required.

public string SubjectTokenType { get; set; }

Property Value

string