Class OnBehalfOfTokenRequest

Namespace

Auth0.AuthenticationApi.Models

Assembly

Auth0.AuthenticationApi.dll

Represents an On-Behalf-Of (OBO) token-exchange request.

public class OnBehalfOfTokenRequest : IClientAuthentication

Inheritance

object

OnBehalfOfTokenRequest

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

Exchanges an incoming user access token (SubjectToken) for a short-lived, audience-scoped access token that preserves user identity and actor attribution. The SDK sets the grant type and subject-token type internally.

Properties

Audience

The target audience (API identifier) the exchanged token is scoped to. Required.

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

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

SubjectToken

The incoming user access token to exchange. Required.

public string SubjectToken { get; set; }

Property Value

string