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

    Interface GetConnectionResponseContent

    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;
    }
    Index

    Properties

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

    Properties

    name?: string

    The name of the connection

    display_name?: string

    Connection name used in login screen

    options?: ConnectionOptions
    id?: string

    The connection's identifier

    strategy?: string

    The type of the connection, related to the identity provider

    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.

    enabled_clients?: string[]

    DEPRECATED property. Use the GET /connections/:id/clients endpoint to get the ids of the clients for which the connection is enabled

    is_domain_connection?: boolean

    True if the connection is domain level

    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.

    metadata?: ConnectionsMetadata

    Settings

    Member Visibility

    On This Page

    Properties