ScmAuth.forBitbucket()

Home > @backstage/integration-react > ScmAuth > forBitbucket

Creates a new ScmAuth instance that handles authentication towards Bitbucket.

The host option determines which URLs that are handled by this instance and defaults to bitbucket.org.

The default scopes are:

account team pullrequest snippet issue

If the additional repoWrite permission is requested, these scopes are added:

pullrequest:write snippet:write issue:write

Signature:

static forBitbucket(bitbucketAuthApi: OAuthApi, options?: {
        host?: string;
        scopeMapping?: {
            default?: string[];
            repoWrite?: string[];
        };
    }): ScmAuth;

Parameters

Parameter	Type	Description
bitbucketAuthApi	OAuthApi
options	{ host?: string; scopeMapping?: { default?: string[]; repoWrite?: string[]; }; }	(Optional)

**Returns:**

ScmAuth