|
|
|
@@ -1,11 +1,14 @@
|
|
|
|
|
# Backstage Core Utility APIs
|
|
|
|
|
---
|
|
|
|
|
id: README
|
|
|
|
|
title: Utility API References
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
The following is a list of all Utility APIs defined by `@backstage/core`. They
|
|
|
|
|
are available to use by plugins and components, and can be accessed using the
|
|
|
|
|
`useApi` hook, also provided by `@backstage/core`. For more information, see
|
|
|
|
|
https://github.com/spotify/backstage/blob/master/docs/api/utility-apis.md.
|
|
|
|
|
|
|
|
|
|
### alert
|
|
|
|
|
## alert
|
|
|
|
|
|
|
|
|
|
Used to report alerts and forward them to the app
|
|
|
|
|
|
|
|
|
@@ -14,7 +17,7 @@ Implemented type: [AlertApi](./AlertApi.md)
|
|
|
|
|
ApiRef:
|
|
|
|
|
[alertApiRef](https://github.com/spotify/backstage/blob/f8780ff32509d0326bc513791ea60846d7614b34/packages/core-api/src/apis/definitions/AlertApi.ts#L41)
|
|
|
|
|
|
|
|
|
|
### appTheme
|
|
|
|
|
## appTheme
|
|
|
|
|
|
|
|
|
|
API Used to configure the app theme, and enumerate options
|
|
|
|
|
|
|
|
|
@@ -23,7 +26,7 @@ Implemented type: [AppThemeApi](./AppThemeApi.md)
|
|
|
|
|
ApiRef:
|
|
|
|
|
[appThemeApiRef](https://github.com/spotify/backstage/blob/f8780ff32509d0326bc513791ea60846d7614b34/packages/core-api/src/apis/definitions/AppThemeApi.ts#L74)
|
|
|
|
|
|
|
|
|
|
### config
|
|
|
|
|
## config
|
|
|
|
|
|
|
|
|
|
Used to access runtime configuration
|
|
|
|
|
|
|
|
|
@@ -32,7 +35,7 @@ Implemented type: [Config](./Config.md)
|
|
|
|
|
ApiRef:
|
|
|
|
|
[configApiRef](https://github.com/spotify/backstage/blob/f8780ff32509d0326bc513791ea60846d7614b34/packages/core-api/src/apis/definitions/ConfigApi.ts#L22)
|
|
|
|
|
|
|
|
|
|
### error
|
|
|
|
|
## error
|
|
|
|
|
|
|
|
|
|
Used to report errors and forward them to the app
|
|
|
|
|
|
|
|
|
@@ -41,7 +44,7 @@ Implemented type: [ErrorApi](./ErrorApi.md)
|
|
|
|
|
ApiRef:
|
|
|
|
|
[errorApiRef](https://github.com/spotify/backstage/blob/f8780ff32509d0326bc513791ea60846d7614b34/packages/core-api/src/apis/definitions/ErrorApi.ts#L65)
|
|
|
|
|
|
|
|
|
|
### featureFlags
|
|
|
|
|
## featureFlags
|
|
|
|
|
|
|
|
|
|
Used to toggle functionality in features across Backstage
|
|
|
|
|
|
|
|
|
@@ -50,7 +53,7 @@ Implemented type: [FeatureFlagsApi](./FeatureFlagsApi.md)
|
|
|
|
|
ApiRef:
|
|
|
|
|
[featureFlagsApiRef](https://github.com/spotify/backstage/blob/f8780ff32509d0326bc513791ea60846d7614b34/packages/core-api/src/apis/definitions/FeatureFlagsApi.ts#L58)
|
|
|
|
|
|
|
|
|
|
### githubAuth
|
|
|
|
|
## githubAuth
|
|
|
|
|
|
|
|
|
|
Provides authentication towards Github APIs
|
|
|
|
|
|
|
|
|
@@ -62,7 +65,7 @@ Implemented types: [OAuthApi](./OAuthApi.md),
|
|
|
|
|
ApiRef:
|
|
|
|
|
[githubAuthApiRef](https://github.com/spotify/backstage/blob/f8780ff32509d0326bc513791ea60846d7614b34/packages/core-api/src/apis/definitions/auth.ts#L230)
|
|
|
|
|
|
|
|
|
|
### gitlabAuth
|
|
|
|
|
## gitlabAuth
|
|
|
|
|
|
|
|
|
|
Provides authentication towards Gitlab APIs
|
|
|
|
|
|
|
|
|
@@ -74,7 +77,7 @@ Implemented types: [OAuthApi](./OAuthApi.md),
|
|
|
|
|
ApiRef:
|
|
|
|
|
[gitlabAuthApiRef](https://github.com/spotify/backstage/blob/f8780ff32509d0326bc513791ea60846d7614b34/packages/core-api/src/apis/definitions/auth.ts#L260)
|
|
|
|
|
|
|
|
|
|
### googleAuth
|
|
|
|
|
## googleAuth
|
|
|
|
|
|
|
|
|
|
Provides authentication towards Google APIs and identities
|
|
|
|
|
|
|
|
|
@@ -87,7 +90,7 @@ Implemented types: [OAuthApi](./OAuthApi.md),
|
|
|
|
|
ApiRef:
|
|
|
|
|
[googleAuthApiRef](https://github.com/spotify/backstage/blob/f8780ff32509d0326bc513791ea60846d7614b34/packages/core-api/src/apis/definitions/auth.ts#L213)
|
|
|
|
|
|
|
|
|
|
### identity
|
|
|
|
|
## identity
|
|
|
|
|
|
|
|
|
|
Provides access to the identity of the signed in user
|
|
|
|
|
|
|
|
|
@@ -96,7 +99,7 @@ Implemented type: [IdentityApi](./IdentityApi.md)
|
|
|
|
|
ApiRef:
|
|
|
|
|
[identityApiRef](https://github.com/spotify/backstage/blob/f8780ff32509d0326bc513791ea60846d7614b34/packages/core-api/src/apis/definitions/IdentityApi.ts#L54)
|
|
|
|
|
|
|
|
|
|
### oauth2
|
|
|
|
|
## oauth2
|
|
|
|
|
|
|
|
|
|
Example of how to use oauth2 custom provider
|
|
|
|
|
|
|
|
|
@@ -107,7 +110,7 @@ Implemented types: [OAuthApi](./OAuthApi.md),
|
|
|
|
|
ApiRef:
|
|
|
|
|
[oauth2ApiRef](https://github.com/spotify/backstage/blob/f8780ff32509d0326bc513791ea60846d7614b34/packages/core-api/src/apis/definitions/auth.ts#L270)
|
|
|
|
|
|
|
|
|
|
### oauthRequest
|
|
|
|
|
## oauthRequest
|
|
|
|
|
|
|
|
|
|
An API for implementing unified OAuth flows in Backstage
|
|
|
|
|
|
|
|
|
@@ -116,7 +119,7 @@ Implemented type: [OAuthRequestApi](./OAuthRequestApi.md)
|
|
|
|
|
ApiRef:
|
|
|
|
|
[oauthRequestApiRef](https://github.com/spotify/backstage/blob/f8780ff32509d0326bc513791ea60846d7614b34/packages/core-api/src/apis/definitions/OAuthRequestApi.ts#L130)
|
|
|
|
|
|
|
|
|
|
### oktaAuth
|
|
|
|
|
## oktaAuth
|
|
|
|
|
|
|
|
|
|
Provides authentication towards Okta APIs
|
|
|
|
|
|
|
|
|
@@ -129,7 +132,7 @@ Implemented types: [OAuthApi](./OAuthApi.md),
|
|
|
|
|
ApiRef:
|
|
|
|
|
[oktaAuthApiRef](https://github.com/spotify/backstage/blob/f8780ff32509d0326bc513791ea60846d7614b34/packages/core-api/src/apis/definitions/auth.ts#L243)
|
|
|
|
|
|
|
|
|
|
### storage
|
|
|
|
|
## storage
|
|
|
|
|
|
|
|
|
|
Provides the ability to store data which is unique to the user
|
|
|
|
|
|
|
|
|
|