Backstage
    Preparing search index...

    Interface ScmAuthTokenOptions

    The options that control a ScmAuthApi.getCredentials call.

    interface ScmAuthTokenOptions {
        additionalScope?: {
            customScopes?: {
                azure?: string[];
                bitbucket?: string[];
                github?: string[];
                gitlab?: string[];
            };
            repoWrite?: boolean;
        };
        instantPopup?: boolean;
        optional?: boolean;
        url: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    additionalScope? instantPopup? optional? url

    Properties

    additionalScope?: {
        customScopes?: {
            azure?: string[];
            bitbucket?: string[];
            github?: string[];
            gitlab?: string[];
        };
        repoWrite?: boolean;
    }

    Whether to request additional access scope.

    Read access to user, organization, and repositories is always included.

    Type Declaration

    • OptionalcustomScopes?: { azure?: string[]; bitbucket?: string[]; github?: string[]; gitlab?: string[] }

      Allow an arbitrary list of scopes provided from the user to request from the provider.

    • OptionalrepoWrite?: boolean

      Requests access to be able to write repository content, including the ability to create things like issues and pull requests.

    instantPopup?: boolean

    If this is set to true, the request will bypass the regular oauth login modal and open the login popup directly.

    The method must be called synchronously from a user action for this to work in all browsers.

    false
    optional?: boolean

    If this is set to true, the user will not be prompted to log in, and an empty response will be returned if there is no existing session.

    This can be used to perform a check whether the user is logged in, or if you don't want to force a user to be logged in, but provide functionality if they already are.

    false
    url: string

    The URL of the SCM resource to be accessed.

    https://github.com/backstage/backstage

    Settings

    Member Visibility

    On This Page

    Properties