• management
• Management
• ConnectionResponseContentOidc

Interface ConnectionResponseContentOidc

Response for connections with strategy=oidc

interface ConnectionResponseContentOidc {
id: string;
realms?: ConnectionRealms;
strategy: "oidc";
authentication?: ConnectionAuthenticationPurpose;
connected_accounts?: ConnectionConnectedAccountsPurposeXaa;
options?: ConnectionOptionsOidc;
show_as_button?: boolean;
name: string;
enabled_clients?: string[];
display_name?: string;
is_domain_connection?: boolean;
metadata?: ConnectionsMetadata;
}

Hierarchy (View Summary)

• ConnectionResponseCommon
  • ConnectionResponseContentOidc

Index

Properties

idrealms?strategyauthentication?connected_accounts?options?show_as_button?nameenabled_clients?display_name?is_domain_connection?metadata?

Properties

id

id: string

Optionalrealms

realms?: ConnectionRealms

strategy

strategy: "oidc"

Optionalauthentication

authentication?: ConnectionAuthenticationPurpose

Optionalconnected_accounts

connected_accounts?: ConnectionConnectedAccountsPurposeXaa

Optionaloptions

options?: ConnectionOptionsOidc

Optionalshow_as_button

show_as_button?: boolean

name

name: string

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.

Optionaldisplay_name

display_name?: string

Optionalis_domain_connection

is_domain_connection?: boolean

Optionalmetadata

metadata?: ConnectionsMetadata

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties idrealmsstrategyauthenticationconnected_accountsoptionsshow_as_buttonnameenabled_clientsdisplay_nameis_domain_connectionmetadata