MonoCloud Management SDK
    Preparing search index...

    Interface CreateExternalProviderRequest

    Create External Provider Request: Used to create an external authenticator.

    CreateExternalProviderRequest

    interface CreateExternalProviderRequest {
        authenticator: ExternalAuthenticators;
        authorization_parameters?: Record<string, string>;
        claim_mappings?: Record<string, string>;
        connection?: CreateExternalProviderConnectionRequest | null;
        credentials?: CreateExternalProviderCredentialsRequest | null;
        display_name?: string | null;
        enable_sign_in?: boolean;
        enable_sign_up?: boolean;
        home_realm_domains?: string[];
        icon?: string | null;
        name: string;
        priority?: number;
        scopes?: string[];
        show_on_login_page?: boolean;
        sync_idp_claims_always?: boolean;
        sync_user_profile_always?: boolean;
        trust_email?: TrustIdentifierModes;
        trust_phone?: TrustIdentifierModes;
    }
    Index

    Properties

    authenticator authorization_parameters? claim_mappings? connection? credentials? display_name? enable_sign_in? enable_sign_up? home_realm_domains? icon? name priority? scopes? show_on_login_page? sync_idp_claims_always? sync_user_profile_always? trust_email? trust_phone?

    Properties

    authenticator: ExternalAuthenticators

    The external identity provider of the connection.

    CreateExternalProviderRequest

    authorization_parameters?: Record<string, string>

    A map of parameter names to the values sent to the external provider's authorization endpoint. A value prefixed with $ forwards the incoming authorization request query parameter with that name; any other value is sent as-is.

    CreateExternalProviderRequest

    claim_mappings?: Record<string, string>

    A map of claim names to upstream source claim names used to map the upstream profile onto the MonoCloud user.

    CreateExternalProviderRequest

    connection?: CreateExternalProviderConnectionRequest | null

    The protocol connection settings used to communicate with the external identity provider. Applies only to custom and enterprise connections.

    CreateExternalProviderRequest

    credentials?: CreateExternalProviderCredentialsRequest | null

    The client credentials issued by the external identity provider. When not set, MonoCloud-managed credentials are used.

    CreateExternalProviderRequest

    display_name?: string | null

    A custom display name for the provider's sign-in button. When not set, the provider's default display name is used.

    CreateExternalProviderRequest

    enable_sign_in?: boolean

    Specifies whether users can sign in using this external identity provider.

    CreateExternalProviderRequest

    enable_sign_up?: boolean

    Specifies whether new users can sign up using this external identity provider.

    CreateExternalProviderRequest

    home_realm_domains?: string[]

    The email domains routed to this provider through home realm discovery.

    CreateExternalProviderRequest

    icon?: string | null

    A custom icon URL for the provider's sign-in button. When not set, the provider's default icon is used.

    CreateExternalProviderRequest

    name: string

    The unique logical name of the connection. Identifies the connection and addresses it through the API.

    CreateExternalProviderRequest

    priority?: number

    The priority of the external provider. Used to order the provider relative to others.

    CreateExternalProviderRequest

    scopes?: string[]

    The set of scopes requested from the external identity provider during authentication.

    CreateExternalProviderRequest

    Optionalshow_on_login_page

    show_on_login_page?: boolean

    Specifies whether the provider's sign-in button is shown on the login page.

    CreateExternalProviderRequest

    sync_idp_claims_always?: boolean

    Specifies whether the IdP claims should be synchronized from the external provider on each successful sign-in.

    CreateExternalProviderRequest

    sync_user_profile_always?: boolean

    Specifies whether the user profile should be synchronized from the external provider on each successful sign-in.

    CreateExternalProviderRequest

    trust_email?: TrustIdentifierModes

    Determines whether the email received from the external provider is treated as verified.

    CreateExternalProviderRequest

    trust_phone?: TrustIdentifierModes

    Determines whether the phone number received from the external provider is treated as verified.

    CreateExternalProviderRequest

    Settings

    On This Page

    Properties