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

    Interface ConnectionOptionsGoogleApps

    Options for the 'google-apps' connection

    interface ConnectionOptionsGoogleApps {
        non_persistent_attrs?: ConnectionNonPersistentAttrs;
        admin_access_token?: string;
        admin_access_token_expiresin?: string;
        admin_refresh_token?: string;
        allow_setting_login_scopes?: boolean;
        api_enable_users?: boolean;
        client_id: string;
        client_secret?: string;
        domain?: string;
        domain_aliases?: ConnectionDomainAliases;
        email?: boolean;
        ext_agreed_terms?: boolean;
        ext_groups?: boolean;
        ext_groups_extended?: boolean;
        ext_is_admin?: boolean;
        ext_is_suspended?: boolean;
        federated_connections_access_tokens?:
            | ConnectionFederatedConnectionsAccessTokens
            | null;
        handle_login_from_social?: boolean;
        icon_url?: string;
        map_user_id_to_id?: boolean;
        profile?: boolean;
        scope?: ConnectionScopeGoogleApps;
        set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum;
        tenant_domain?: string;
        upstream_params?: ConnectionUpstreamParams;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any

      Accepts any additional properties

    Index

    Properties

    non_persistent_attrs? admin_access_token? admin_access_token_expiresin? admin_refresh_token? allow_setting_login_scopes? api_enable_users? client_id client_secret? domain? domain_aliases? email? ext_agreed_terms? ext_groups? ext_groups_extended? ext_is_admin? ext_is_suspended? federated_connections_access_tokens? handle_login_from_social? icon_url? map_user_id_to_id? profile? scope? set_user_root_attributes? tenant_domain? upstream_params?

    Properties

    non_persistent_attrs?: ConnectionNonPersistentAttrs
    admin_access_token?: string
    admin_access_token_expiresin?: string
    admin_refresh_token?: string
    allow_setting_login_scopes?: boolean

    When true, allows customization of OAuth scopes requested during user login. Custom scopes are appended to the mandatory email and profile scopes. When false or omitted, only the default email and profile scopes are used. This property is automatically enabled when Token Vault or Connected Accounts features are activated.

    api_enable_users?: boolean
    client_id: string
    client_secret?: string
    domain?: string
    domain_aliases?: ConnectionDomainAliases
    email?: boolean

    Whether the OAuth flow requests the email scope.

    ext_agreed_terms?: boolean
    ext_groups?: boolean
    ext_groups_extended?: boolean

    Controls whether enriched group entries include id, email, name (true) or only the group name (false); can only be set when ext_groups is true.

    ext_is_admin?: boolean
    ext_is_suspended?: boolean
    federated_connections_access_tokens?:
        | ConnectionFederatedConnectionsAccessTokens
        | null
    handle_login_from_social?: boolean
    icon_url?: string
    map_user_id_to_id?: boolean

    Determines how Auth0 generates the user_id for Google Workspace users. When false (default), the user's email address is used. When true, Google's stable numeric user ID is used instead, which persists even if the user's email changes. This setting can only be configured when creating the connection and cannot be changed afterward.

    profile?: boolean

    Whether the OAuth flow requests the profile scope.

    scope?: ConnectionScopeGoogleApps
    set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum
    tenant_domain?: string
    upstream_params?: ConnectionUpstreamParams

    Settings

    Member Visibility

    On This Page

    Properties