Interface ConnectionUpdate

Hierarchy

  • ConnectionUpdate

Properties

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

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[]

DEPRECATED property. Use the PATCH /v2/connections/{id}/clients endpoint to enable or disable the connection for any clients.

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.

Optional show_as_button

show_as_button?: boolean

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.)

Settings

Member Visibility

Theme

On This Page