• management
• Management
• CreateConnectionRequestContent

Interface CreateConnectionRequestContent

Example

{ * name: "name", * strategy: "ad" * }Copy

interface CreateConnectionRequestContent {
name: string;
display_name?: string;
strategy: Management.ConnectionIdentityProviderEnum;
options?: ConnectionPropertiesOptions;
enabled_clients?: string[];
is_domain_connection?: boolean;
show_as_button?: boolean;
realms?: string[];
metadata?: ConnectionsMetadata;
authentication?: ConnectionAuthenticationPurpose;
connected_accounts?: ConnectionConnectedAccountsPurpose;
}

Index

Properties

namedisplay_name?strategyoptions?enabled_clients?is_domain_connection?show_as_button?realms?metadata?authentication?connected_accounts?

Properties

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

Optionaldisplay_name

display_name?: string

Connection name used in the new universal login experience

strategy

strategy: Management.ConnectionIdentityProviderEnum

Optionaloptions

options?: ConnectionPropertiesOptions

Optionalenabled_clients

enabled_clients?: string[]

Use of this property is NOT RECOMMENDED. Use the PATCH /v2/connections/{id}/clients endpoint to enable the connection for a set of clients.

Optionalis_domain_connection

is_domain_connection?: boolean

true promotes to a domain-level connection so that third-party applications can use it. false does not promote the connection, so only first-party applications with the connection enabled can use it. (Defaults to false.)

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

Optionalrealms

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.

Optionalmetadata

metadata?: ConnectionsMetadata

Optionalauthentication

authentication?: ConnectionAuthenticationPurpose

Optionalconnected_accounts

connected_accounts?: ConnectionConnectedAccountsPurpose

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties namedisplay_namestrategyoptionsenabled_clientsis_domain_connectionshow_as_buttonrealmsmetadataauthenticationconnected_accounts