Type Alias AuthorizationRequirementsError

AuthorizationRequirementsError: {
    authorization_parameters: {
        prompt?: string;
        required_scopes?: string[];
        session_message?: string;
        session_required_identities?: string[];
        session_required_mfa?: boolean;
        session_required_policies?: string[];
        session_required_single_domain?: string[];
    };
    [key: string]: unknown;
}

An error that includes an authorization_parameters property, a.k.a "G.A.R.E".

A well-known error shape is provided by services when additional authorization requirements must be met by the session. This object can be converted to parameters accepted by Globus Auth using sdk.errors.toAuthorizationQueryParams().

Type declaration

  • [key: string]: unknown

    Todo

    At the moment, most Globus services do not guarentee a code property for this error type. Once it becomes more common, this type (and the isAuthorizationRequirementsError function) should be updated.

    See

    https://globus-sdk-python.readthedocs.io/en/stable/experimental/auth_requirements_errors.html

  • authorization_parameters: {
        prompt?: string;
        required_scopes?: string[];
        session_message?: string;
        session_required_identities?: string[];
        session_required_mfa?: boolean;
        session_required_policies?: string[];
        session_required_single_domain?: string[];
    }
    • Optionalprompt?: string
    • Optionalrequired_scopes?: string[]
    • Optionalsession_message?: string
    • Optionalsession_required_identities?: string[]
    • Optionalsession_required_mfa?: boolean
    • Optionalsession_required_policies?: string[]
    • Optionalsession_required_single_domain?: string[]

Settings

Member Visibility