• management
• Management
• UpdateConnectionRequestContent

Interface UpdateConnectionRequestContent

Example

{}Copy

interface UpdateConnectionRequestContent {
display_name?: string;
options?: UpdateConnectionOptions | null;
enabled_clients?: string[] | null;
is_domain_connection?: boolean;
show_as_button?: boolean;
realms?: string[];
metadata?: ConnectionsMetadata;
authentication?: ConnectionAuthenticationPurpose;
connected_accounts?: ConnectionConnectedAccountsPurpose;
}

Index

Properties

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

Properties

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

Optionaloptions

options?: UpdateConnectionOptions | null

Optionalenabled_clients

enabled_clients?: string[] | null

DEPRECATED property. Use the PATCH /v2/connections/{id}/clients endpoint to enable or disable the connection for any 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 display_nameoptionsenabled_clientsis_domain_connectionshow_as_buttonrealmsmetadataauthenticationconnected_accounts