ScmAuth.forGithub()

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

Creates a new ScmAuth instance that handles authentication towards GitHub.

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

The default scopes are:

repo read:org read:user

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

gist

Signature:

static forGithub(githubAuthApi: OAuthApi, options?: {
        host?: string;
    }): ScmAuth;

Parameters

Parameter	Type	Description
githubAuthApi	OAuthApi
options	{ host?: string; }	(Optional)

**Returns:**

ScmAuth