Interface ConnectionForList

Hierarchy

  • ConnectionForList

Properties

display_name? id? is_domain_connection? metadata? name? options? realms? show_as_button? strategy?

Properties

Optional display_name

display_name?: string

Connection name used in login screen

Optional id

id?: string

The connection's identifier

Optional is_domain_connection

is_domain_connection?: boolean

True if the connection is domain level

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 name

name?: string

The name of the connection

Optional options

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

In order to return options in the response, the read:connections_options scope must be present

Type declaration

  • [key: string]: any

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.

Optional strategy

strategy?: string

The type of the connection, related to the identity provider

Settings

Member Visibility

Theme

On This Page