Type Alias SignInResult

SignInResult:
    | {
        status: "success";
        token: string;
    }
    | {
        status: "cancelled";
        message?: string;
    }
    | {
        status: "rate_limited";
        retryAfter?: number;
        message?: string;
    }
    | {
        status: "unavailable";
        message?: string;
    }
    | {
        status: "unsupported";
        message?: string;
    }
    | {
        status: "failed";
        message?: string;
    }

Type declaration

  • status: "success"

    SSO completed. The token is a handover token for the embed backend.

  • token: string

Type declaration

  • status: "cancelled"

    The user cancelled or abandoned the host-side sign-in flow.

  • Optionalmessage?: string

    Developer/debug message. Do not show directly to end users.

Type declaration

  • status: "rate_limited"

    A sign-in request is already pending or was requested too recently.

  • OptionalretryAfter?: number

    Seconds until another request may be attempted.

  • Optionalmessage?: string

    Developer/debug message. Do not show directly to end users.

Type declaration

  • status: "unavailable"

    SSO is not available for this embed.

  • Optionalmessage?: string

    Developer/debug message. Do not show directly to end users.

Type declaration

  • status: "unsupported"

    The host does not support runtime SSO requests.

  • Optionalmessage?: string

    Developer/debug message. Do not show directly to end users.

Type declaration

  • status: "failed"

    The host attempted SSO, but the flow failed.

  • Optionalmessage?: string

    Developer/debug message. Do not show directly to end users.

Settings