Interface ConnectionUpdate

Hierarchy

  • ConnectionUpdate

Properties

display_name? enabled_clients? is_domain_connection? metadata? options? realms?

Properties

Optional display_name

display_name?: string

The connection name used in the new universal login experience. If display_name is not included in the request, the field will be overwritten with the name value.

Optional enabled_clients

enabled_clients?: string[]

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

Optional is_domain_connection

is_domain_connection?: boolean

Optional metadata

metadata?: {
    [key: string]: any;
}

Metadata associated with the connection in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed.

Type declaration

  • [key: string]: any

Optional options

options?: null | ConnectionUpdateOptions

Optional realms

realms?: string[]

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.

Settings

Member Visibility

Theme

On This Page