docs/interfaces/management.Management.GetConnectionResponseContent.html
interface GetConnectionResponseContent {
name?: string;
display_name?: string;
options?: ConnectionOptions;
id?: string;
strategy?: string;
realms?: string[];
enabled_clients?: string[];
is_domain_connection?: boolean;
show_as_button?: boolean;
metadata?: ConnectionsMetadata;
authentication?: ConnectionAuthenticationPurpose;
connected_accounts?: ConnectionConnectedAccountsPurpose;
}
name?display_name?options?id?strategy?realms?enabled_clients?is_domain_connection?show_as_button?metadata?authentication?connected_accounts?
Optionalnamename?: string
The name of the connection
Optionaldisplay_namedisplay_name?: string
Connection name used in login screen
Optionaloptionsoptions?: ConnectionOptions
Optionalidid?: string
The connection's identifier
Optionalstrategystrategy?: string
The type of the connection, related to the identity provider
Optionalrealmsrealms?: 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.
Optionalenabled_clientsenabled_clients?: string[]
DEPRECATED property. Use the GET /connections/:id/clients endpoint to get the ids of the clients for which the connection is enabled
Optionalis_domain_connectionis_domain_connection?: boolean
True if the connection is domain level
Optionalshow_as_buttonshow_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.
Optionalmetadatametadata?: ConnectionsMetadata
Optionalauthenticationauthentication?: ConnectionAuthenticationPurpose
Optionalconnected_accountsconnected_accounts?: ConnectionConnectedAccountsPurpose
Member Visibility
ThemeOSLightDark
Properties namedisplay_nameoptionsidstrategyrealmsenabled_clientsis_domain_connectionshow_as_buttonmetadataauthenticationconnected_accounts