Class ConnectionOptionsOAuth2

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

Options for the 'oauth2' connection

[Serializable]
public record ConnectionOptionsOAuth2 : IJsonOnDeserialized, IJsonOnSerializing, IEquatable<ConnectionOptionsOAuth2>

Inheritance

object

ConnectionOptionsOAuth2

Implements

IJsonOnDeserialized

IJsonOnSerializing

IEquatable<ConnectionOptionsOAuth2>

Inherited Members

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)

Properties

AdditionalProperties

[JsonIgnore]
public AdditionalProperties AdditionalProperties { get; set; }

Property Value

AdditionalProperties

AuthParams

[JsonPropertyName("authParams")]
public Dictionary<string, string>? AuthParams { get; set; }

Property Value

Dictionary<string, string>

AuthParamsMap

[JsonPropertyName("authParamsMap")]
public Dictionary<string, string>? AuthParamsMap { get; set; }

Property Value

Dictionary<string, string>

AuthorizationUrl

[JsonPropertyName("authorizationURL")]
public string? AuthorizationUrl { get; set; }

Property Value

string

ClientId

[JsonPropertyName("client_id")]
public string? ClientId { get; set; }

Property Value

string

ClientSecret

[JsonPropertyName("client_secret")]
public string? ClientSecret { get; set; }

Property Value

string

CustomHeaders

[JsonPropertyName("customHeaders")]
public Dictionary<string, string>? CustomHeaders { get; set; }

Property Value

Dictionary<string, string>

FieldsMap

[JsonPropertyName("fieldsMap")]
public Dictionary<string, string>? FieldsMap { get; set; }

Property Value

Dictionary<string, string>

IconUrl

[JsonPropertyName("icon_url")]
public string? IconUrl { get; set; }

Property Value

string

LogoutUrl

[JsonPropertyName("logoutUrl")]
public string? LogoutUrl { get; set; }

Property Value

string

NonPersistentAttrs

[JsonPropertyName("non_persistent_attrs")]
public IEnumerable<string>? NonPersistentAttrs { get; set; }

Property Value

IEnumerable<string>

PkceEnabled

When true, enables Proof Key for Code Exchange (PKCE) for the authorization code flow. PKCE provides additional security by preventing authorization code interception attacks.

[JsonPropertyName("pkce_enabled")]
public bool? PkceEnabled { get; set; }

Property Value

bool?

Scope

[JsonPropertyName("scope")]
public ConnectionScopeOAuth2? Scope { get; set; }

Property Value

ConnectionScopeOAuth2

Scripts

[JsonPropertyName("scripts")]
public ConnectionScriptsOAuth2? Scripts { get; set; }

Property Value

ConnectionScriptsOAuth2

SetUserRootAttributes

[JsonPropertyName("set_user_root_attributes")]
public ConnectionSetUserRootAttributesEnum? SetUserRootAttributes { get; set; }

Property Value

ConnectionSetUserRootAttributesEnum?

TokenUrl

[JsonPropertyName("tokenURL")]
public string? TokenUrl { get; set; }

Property Value

string

UpstreamParams

[JsonPropertyName("upstream_params")]
public Optional<Dictionary<string, ConnectionUpstreamAdditionalProperties?>?> UpstreamParams { get; set; }

Property Value

Optional<Dictionary<string, ConnectionUpstreamAdditionalProperties>>

UseOauthSpecScope

When true, uses space-delimited scopes (per OAuth 2.0 spec) instead of comma-delimited when calling the identity provider's authorization endpoint. Only relevant when using the connection_scope parameter. See https://auth0.com/docs/authenticate/identity-providers/adding-scopes-for-an-external-idp#pass-scopes-to-authorize-endpoint

[JsonPropertyName("useOauthSpecScope")]
public bool? UseOauthSpecScope { get; set; }

Property Value

bool?

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.