Type Alias AuthorizationRequirementsError

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 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;
}

Indexable

[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

Index

Properties

authorization_parameters

Properties

authorization_parameters

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[];
}

Type Alias AuthorizationRequirementsError

Indexable

Todo

See

Index

Properties

Properties

authorization_parameters

Settings

On This Page