MonoCloud Management SDK
    Preparing search index...

    Interface PatchExternalProviderRequest

    Patch External Provider Request: Used to update an external authenticator's configuration.

    PatchExternalProviderRequest

    interface PatchExternalProviderRequest {
        authorization_parameters?: Record<string, string>;
        claim_mappings?: Record<string, string>;
        connection?: PatchExternalProviderConnectionRequest | null;
        credentials?: PatchExternalProviderCredentialsRequest | null;
        display_name?: string | null;
        enable_sign_in?: boolean;
        enable_sign_up?: boolean;
        home_realm_domains?: string[];
        icon?: string | null;
        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

    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.

    PatchExternalProviderRequest

    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.

    PatchExternalProviderRequest

    The protocol connection settings used to communicate with the external identity provider.

    PatchExternalProviderRequest

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

    PatchExternalProviderRequest

    display_name?: string | null

    A custom display name for the provider's sign-in button.

    PatchExternalProviderRequest

    enable_sign_in?: boolean

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

    PatchExternalProviderRequest

    enable_sign_up?: boolean

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

    PatchExternalProviderRequest

    home_realm_domains?: string[]

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

    PatchExternalProviderRequest

    icon?: string | null

    A custom icon URL for the provider's sign-in button.

    PatchExternalProviderRequest

    priority?: number

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

    PatchExternalProviderRequest

    scopes?: string[]

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

    PatchExternalProviderRequest

    show_on_login_page?: boolean

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

    PatchExternalProviderRequest

    sync_idp_claims_always?: boolean

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

    PatchExternalProviderRequest

    sync_user_profile_always?: boolean

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

    PatchExternalProviderRequest

    trust_email?: TrustIdentifierModes

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

    PatchExternalProviderRequest

    trust_phone?: TrustIdentifierModes

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

    PatchExternalProviderRequest