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? strategy authentication? connected_accounts? options? show_as_button?

Properties

name

name: string

`Optional`enabled_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.

`Optional`display_name

display_name?: string

`Optional`is_domain_connection

is_domain_connection?: boolean

`Optional`metadata

metadata?: ConnectionsMetadata

strategy

strategy: "oidc"

`Optional`authentication

authentication?: ConnectionAuthenticationPurpose

`Optional`connected_accounts

connected_accounts?: ConnectionConnectedAccountsPurposeXaa

`Optional`options

options?: ConnectionOptionsOidc

`Optional`show_as_button

show_as_button?: boolean