Class ResourceOwnerTokenRequest

Namespace

Auth0.AuthenticationApi.Models

Assembly

Auth0.AuthenticationApi.dll

Represents a request get a token using the Resource Owner Grant flow.

public class ResourceOwnerTokenRequest : IClientAuthentication

Inheritance

object

ResourceOwnerTokenRequest

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)

Properties

Audience

Optional unique identifier of the target API to access.

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

Optional client secret of the application.

public string ClientSecret { get; set; }

Property Value

string

ForwardedForIp

IP address of the end user this token is requested for.

public string ForwardedForIp { get; set; }

Property Value

string

Remarks

It is important to set this if using this API server-side. See https://auth0.com/docs/api-auth/tutorials/using-resource-owner-password-from-server-side for more details.

Nonce

Optional nonce to validate against the nonce claim in the 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.

Password

Resource Owner's secret.

public string Password { get; set; }

Property Value

string

Realm

Optional realm the user belongs to.

public string Realm { get; set; }

Property Value

string

Remarks

See https://auth0.com/docs/api-auth/grant/password#realm-support for more details.

Scope

Optional scopes to be requested. Separate multiple values with a space.

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

Username

Resource Owner's identifier.

public string Username { get; set; }

Property Value

string