Dominik HennekeBackstage Core Utility APIs
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/backstage/backstage/blob/master/docs/api/utility-apis.md.
alert
Used to report alerts and forward them to the app
Implemented type: AlertApi
ApiRef: alertApiRef
appTheme
API Used to configure the app theme, and enumerate options
Implemented type: AppThemeApi
ApiRef: appThemeApiRef
auth0Auth
Provides authentication towards Auth0 APIs
Implemented types: OpenIdConnectApi, ProfileInfoApi, BackstageIdentityApi, SessionApi
ApiRef: auth0AuthApiRef
config
Used to access runtime configuration
Implemented type: Config
ApiRef: configApiRef
discovery
Provides service discovery of backend plugins
Implemented type: DiscoveryApi
ApiRef: discoveryApiRef
error
Used to report errors and forward them to the app
Implemented type: ErrorApi
ApiRef: errorApiRef
featureFlags
Used to toggle functionality in features across Backstage
Implemented type: FeatureFlagsApi
ApiRef: featureFlagsApiRef
githubAuth
Provides authentication towards GitHub APIs
Implemented types: OAuthApi, ProfileInfoApi, BackstageIdentityApi, SessionApi
ApiRef: githubAuthApiRef
gitlabAuth
Provides authentication towards GitLab APIs
Implemented types: OAuthApi, ProfileInfoApi, BackstageIdentityApi, SessionApi
ApiRef: gitlabAuthApiRef
googleAuth
Provides authentication towards Google APIs and identities
Implemented types: OAuthApi, OpenIdConnectApi, ProfileInfoApi, BackstageIdentityApi, SessionApi
ApiRef: googleAuthApiRef
identity
Provides access to the identity of the signed in user
Implemented type: IdentityApi
ApiRef: identityApiRef
microsoftAuth
Provides authentication towards Microsoft APIs and identities
Implemented types: OAuthApi, OpenIdConnectApi, ProfileInfoApi, BackstageIdentityApi, SessionApi
ApiRef: microsoftAuthApiRef
oauth2
Example of how to use oauth2 custom provider
Implemented types: OAuthApi, OpenIdConnectApi, ProfileInfoApi, BackstageIdentityApi, SessionApi
ApiRef: oauth2ApiRef
oauthRequest
An API for implementing unified OAuth flows in Backstage
Implemented type: OAuthRequestApi
ApiRef: oauthRequestApiRef
oktaAuth
Provides authentication towards Okta APIs
Implemented types: OAuthApi, OpenIdConnectApi, ProfileInfoApi, BackstageIdentityApi, SessionApi
ApiRef: oktaAuthApiRef
samlAuth
Example of how to use SAML custom provider
Implemented types: ProfileInfoApi, BackstageIdentityApi, SessionApi
ApiRef: samlAuthApiRef
storage
Provides the ability to store data which is unique to the user
Implemented type: StorageApi
ApiRef: storageApiRef