Interface ConnectionCreate

Hierarchy

  • ConnectionCreate

Properties

display_name? enabled_clients? is_domain_connection? metadata? name options? realms? strategy

Properties

Optional display_name

display_name?: string

Connection name used in the new universal login experience

Optional enabled_clients

enabled_clients?: string[]

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

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

name

name: string

The name of the connection. Must start and end with an alphanumeric character and can only contain alphanumeric characters and '-'. Max length 128

Optional options

options?: ConnectionCreateOptions

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.

strategy

strategy: ConnectionCreateStrategyEnum

The identity provider identifier for the connection

Settings

Member Visibility

Theme

On This Page