Skip to main content

ScmAuth.forGitlab()

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

Creates a new ScmAuth instance that handles authentication towards GitLab.

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

The default scopes are:

read_user read_api read_repository

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

write_repository api

Signature:

static forGitlab(gitlabAuthApi: OAuthApi, options?: {
host?: string;
}): ScmAuth;

Parameters

ParameterTypeDescription
gitlabAuthApiOAuthApi
options{ host?: string; }(Optional)

Returns:

ScmAuth