Version: Next

@backstage/integration-react

Frontend package for managing integrations towards external systems

Classes

Class	Description
ScmAuth	An implementation of the ScmAuthApi that merges together OAuthApi instances to form a single instance that can handles authentication for multiple providers.
ScmIntegrationsApi	Factory class for creating ScmIntegrationRegistry instances.

Function	Description
ScmIntegrationIcon(props)	An icon that represents a certain SCM integration.

Interface	Description
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.
ScmAuthTokenOptions	The options that control a ScmAuthApi.getCredentials() call.
ScmAuthTokenResponse	The response from a ScmAuthApi.getCredentials() call.

Interface

Description

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.

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

Variable	Description
scmAuthApiRef	The ApiRef for the ScmAuthApi.
scmIntegrationsApiRef	The API that holds all configured SCM integrations.

Type Alias	Description
ScmIntegrationIconProps	Props for ScmIntegrationIcon().