Class CreateConnectionRequestContent

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

[Serializable]
public record CreateConnectionRequestContent : IEquatable<CreateConnectionRequestContent>

Inheritance

object

CreateConnectionRequestContent

Implements

IEquatable<CreateConnectionRequestContent>

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

Authentication

[JsonPropertyName("authentication")]
public ConnectionAuthenticationPurpose? Authentication { get; set; }

Property Value

ConnectionAuthenticationPurpose

ConnectedAccounts

[JsonPropertyName("connected_accounts")]
public ConnectionConnectedAccountsPurpose? ConnectedAccounts { get; set; }

Property Value

ConnectionConnectedAccountsPurpose

DisplayName

Connection name used in the new universal login experience

[JsonPropertyName("display_name")]
public string? DisplayName { get; set; }

Property Value

string

EnabledClients

Use of this property is NOT RECOMMENDED. Use the PATCH /v2/connections/{id}/clients endpoint to enable the connection for a set of clients.

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

Property Value

IEnumerable<string>

IsDomainConnection

true promotes to a domain-level connection so that third-party applications can use it. false does not promote the connection, so only first-party applications with the connection enabled can use it. (Defaults to false.)

[JsonPropertyName("is_domain_connection")]
public bool? IsDomainConnection { get; set; }

Property Value

bool?

Metadata

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

Property Value

Dictionary<string, string>

Name

The name of the connection. Must start and end with an alphanumeric character and can only contain alphanumeric characters and '-'. Max length 128

[JsonPropertyName("name")]
public required string Name { get; set; }

Property Value

string

Options

[JsonPropertyName("options")]
public ConnectionPropertiesOptions? Options { get; set; }

Property Value

ConnectionPropertiesOptions

Realms

Defines the realms for which the connection will be used (ie: email domains). If the array is empty or the property is not specified, the connection name will be added as realm.

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

Property Value

IEnumerable<string>

ShowAsButton

Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by HRD. (Defaults to false.)

[JsonPropertyName("show_as_button")]
public bool? ShowAsButton { get; set; }

Property Value

bool?

Strategy

[JsonPropertyName("strategy")]
public required ConnectionIdentityProviderEnum Strategy { get; set; }

Property Value

ConnectionIdentityProviderEnum

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.