Class ConnectionBase

Namespace

Auth0.ManagementApi.Models

Assembly

Auth0.ManagementApi.dll

Base class for connections which includes both request and responses.

public abstract class ConnectionBase

Inheritance

object

ConnectionBase

Derived

Connection

ConnectionCreateRequest

ConnectionUpdateRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

DisplayName

The text used on the login button.

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

Property Value

string

EnabledClients

The identifiers of the clients for which the connection is to be enabled. If the array is empty or the property is not specified, no clients are enabled.

[JsonProperty("enabled_clients")]
public string[] EnabledClients { get; set; }

Property Value

string[]

IsDomainConnection

Whether the connection is domain level (true), or not (false).

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

Property Value

bool

Metadata

Optional metadata for the connection.

[JsonProperty("metadata")]
public dynamic Metadata { get; set; }

Property Value

dynamic

Name

The name of the connection.

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

Property Value

string

Remarks

Must start with an alphanumeric characters and can only contain alphanumeric characters and '-'. Max length 35.

Options

The options for the connection.

[JsonProperty("options")]
public dynamic Options { get; set; }

Property Value

dynamic

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. Maximum of 10 items.

[JsonProperty("realms")]
public string[] Realms { get; set; }

Property Value

string[]

ShowAsButton

True to show this connection as a button on login, false otherwise.

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

Property Value

bool?