MonoCloud Management SDK
    Preparing search index...

    Interface PatchXeroAuthenticatorOptionsRequest

    Patch Xero Authenticator Options Request: Used to partially update Sign in with Xero configuration and behavior.

    PatchXeroAuthenticatorOptionsRequest

    interface PatchXeroAuthenticatorOptionsRequest {
        client_id?: string | null;
        client_secret?: string | null;
        enable_sign_in?: boolean;
        enable_sign_up?: boolean;
        scopes?: string[];
        sync_user_profile_always?: boolean;
        treat_email_as_verified?: boolean;
        use_internal_keys?: boolean;
    }
    Index

    Properties

    client_id? client_secret? enable_sign_in? enable_sign_up? scopes? sync_user_profile_always? treat_email_as_verified? use_internal_keys?

    Properties

    client_id?: string | null

    The client identifier issued by the external identity provider.

    PatchXeroAuthenticatorOptionsRequest

    client_secret?: string | null

    The client secret issued by the external identity provider.

    PatchXeroAuthenticatorOptionsRequest

    enable_sign_in?: boolean

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

    PatchXeroAuthenticatorOptionsRequest

    enable_sign_up?: boolean

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

    PatchXeroAuthenticatorOptionsRequest

    scopes?: string[]

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

    PatchXeroAuthenticatorOptionsRequest

    sync_user_profile_always?: boolean

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

    PatchXeroAuthenticatorOptionsRequest

    treat_email_as_verified?: boolean

    Specifies whether email addresses returned by Xero should be treated as verified.

    Xero does not provide an explicit email verification claim. When enabled, MonoCloud treats the email provided by Xero as verified and skips additional email verification.

    PatchXeroAuthenticatorOptionsRequest

    use_internal_keys?: boolean

    Specifies whether MonoCloud-managed client credentials should be used to authenticate with the external identity provider.

    PatchXeroAuthenticatorOptionsRequest

    Settings

    On This Page

    Properties