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

    Interface EventStreamCloudEventConnectionUpdatedObject2

    interface EventStreamCloudEventConnectionUpdatedObject2 {
        authentication?: EventStreamCloudEventConnectionUpdatedObject2Authentication;
        connected_accounts?: EventStreamCloudEventConnectionUpdatedObject2ConnectedAccounts;
        display_name?: string;
        enabled_clients?: string[];
        id: string;
        is_domain_connection?: boolean;
        metadata?: EventStreamCloudEventConnectionUpdatedObject2Metadata;
        name: string;
        realms?: string[];
        options?: EventStreamCloudEventConnectionUpdatedObject2Options;
        show_as_button?: boolean;
        strategy: "samlp";
    }
    Index

    Properties

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

    Properties

    authentication?: EventStreamCloudEventConnectionUpdatedObject2Authentication
    connected_accounts?: EventStreamCloudEventConnectionUpdatedObject2ConnectedAccounts
    display_name?: string

    Connection name used in the new universal login experience

    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.

    id: string

    The connection's identifier

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

    metadata?: EventStreamCloudEventConnectionUpdatedObject2Metadata
    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

    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.

    options?: EventStreamCloudEventConnectionUpdatedObject2Options
    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.

    strategy: "samlp"

    Settings

    Member Visibility

    On This Page

    Properties