Interface Connection

Hierarchy

  • Connection

Properties

display_name id is_domain_connection metadata name options realms strategy

Properties

display_name

display_name: string

Connection name used in login screen

id

id: string

The connection's identifier

is_domain_connection

is_domain_connection: boolean

True if the connection is domain level

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

name

name: string

The name of the connection

options

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

Type declaration

  • [key: string]: any

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.

strategy

strategy: string

The type of the connection, related to the identity provider

Settings

Member Visibility

Theme

On This Page