• management
• Management
• CreateConnectionRequestContentOidc

Interface CreateConnectionRequestContentOidc

Create a connection with strategy=oidc

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

Hierarchy (View Summary)

• CreateConnectionCommon
  • CreateConnectionRequestContentOidc

Index

Properties

name?enabled_clients?display_name?is_domain_connection?metadata?strategyauthentication?connected_accounts?options?show_as_button?

Properties

Optionalname

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

strategy

strategy: "oidc"

Optionalauthentication

authentication?: ConnectionAuthenticationPurpose

Optionalconnected_accounts

connected_accounts?: ConnectionConnectedAccountsPurposeXaa

Optionaloptions

options?: ConnectionOptionsOidc

Optionalshow_as_button

show_as_button?: boolean

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties nameenabled_clientsdisplay_nameis_domain_connectionmetadatastrategyauthenticationconnected_accountsoptionsshow_as_button