Version: Next

ScmAuthTokenOptions

The options that control a ScmAuthApi.getCredentials() call.

Signature:

export interface ScmAuthTokenOptions extends AuthRequestOptions 

Extends: AuthRequestOptions

Properties

Property	Modifiers	Type	Description
additionalScope?		{ repoWrite?: boolean; customScopes?: { github?: string[]; azure?: string[]; bitbucket?: string[]; gitlab?: string[]; }; }	(Optional) Whether to request additional access scope. Read access to user, organization, and repositories is always included.
url		string	The URL of the SCM resource to be accessed.

Property

Modifiers

Type

Description

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

(Optional) Whether to request additional access scope.

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

string

The URL of the SCM resource to be accessed.