Interface ScmAuthApi

ScmAuthApi provides methods for authenticating towards source code management services.

As opposed to using the GitHub, GitLab and other auth APIs directly, this API allows for more generic access to SCM services.

interface ScmAuthApi {
    getCredentials(
        options: ScmAuthTokenOptions,
    ): Promise<ScmAuthTokenResponse>;
}

Implemented by

ScmAuth

Index

Methods

Methods

getCredentials

getCredentials(options: ScmAuthTokenOptions): Promise<ScmAuthTokenResponse>
Requests credentials for accessing an SCM resource.
Parameters
- options: ScmAuthTokenOptions
Returns Promise<ScmAuthTokenResponse>
- Defined in packages/integration-react/src/api/ScmAuthApi.ts:89