Auth0 Node.js SDK - v5.0.0
    Preparing search index...

    Interface CreateConnectionRequestContent

    {
     *         name: "name",
     *         strategy: "ad"
     *     }
    interface CreateConnectionRequestContent {
        name: string;
        display_name?: string;
        strategy: Management.ConnectionIdentityProviderEnum;
        options?: ConnectionPropertiesOptions;
        enabled_clients?: string[];
        is_domain_connection?: boolean;
        show_as_button?: boolean;
        realms?: string[];
        metadata?: ConnectionsMetadata;
    }
    Index

    Properties

    name display_name? strategy options? enabled_clients? is_domain_connection? show_as_button? realms? metadata?

    Properties

    name: string

    The name of the connection. Must start and end with an alphanumeric character and can only contain alphanumeric characters and '-'. Max length 128

    display_name?: string

    Connection name used in the new universal login experience

    strategy: Management.ConnectionIdentityProviderEnum
    options?: ConnectionPropertiesOptions
    enabled_clients?: string[]

    DEPRECATED property. Use the PATCH /v2/connections/{id}/clients endpoint to enable the connection for a set of clients.

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

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

    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.

    metadata?: ConnectionsMetadata

    Settings

    Member Visibility

    On This Page

    Properties