Class FederatedConnectionAccessTokenRequest

Namespace

Auth0.AuthenticationApi.Models

Assembly

Auth0.AuthenticationApi.dll

Represents a request to exchange an Auth0 token for an access token issued by one of Auth0's federated connections (Token Vault), using the Auth0 token-exchange grant urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token.

public class FederatedConnectionAccessTokenRequest : IClientAuthentication

Inheritance

object

FederatedConnectionAccessTokenRequest

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 client must be a private client. The subject token may be an Auth0 access token (AccessToken) or refresh token (RefreshToken).

Properties

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

Connection

The federated connection to obtain the access token for (for example google-oauth2). Required.

public string Connection { get; set; }

Property Value

string

LoginHint

Optional user ID of the current user within the IdP named by Connection. For example, if the connection is google-oauth2, this is the Google user ID.

public string LoginHint { 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.

SigningAlgorithm

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

public JwtSignatureAlgorithm SigningAlgorithm { get; set; }

Property Value

JwtSignatureAlgorithm

SubjectToken

The Auth0 token being exchanged. This may be a valid Auth0 access token or refresh token. Required.

public string SubjectToken { get; set; }

Property Value

string

SubjectTokenType

An identifier that indicates the type of SubjectToken, as a URN. Either AccessToken or RefreshToken. Required.

public string SubjectTokenType { get; set; }

Property Value

string