core-app-api: deprecated Auth0Auth

Co-authored-by: Johan Haals <johan.haals@gmail.com> Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-12-13 11:50:16 +01:00
parent 8a7372cfd5
commit c11ce4f552
3 changed files with 23 additions and 1 deletions
@@ -0,0 +1,5 @@
+---
+'@backstage/core-app-api': patch
+---
+
+Deprecated `Auth0Auth`, pointing to using `OAuth2` directly instead.
@@ -254,7 +254,7 @@ export class AtlassianAuth {
  static create(options: OAuthApiCreateOptions): typeof atlassianAuthApiRef.T;
 }

-// @public
+// @public @deprecated
 export class Auth0Auth {
  // (undocumented)
  static create(options: OAuthApiCreateOptions): typeof auth0AuthApiRef.T;
@@ -28,6 +28,23 @@ const DEFAULT_PROVIDER = {
 * Implements the OAuth flow to Auth0 products.
 *
 * @public
+ * @deprecated Use {@link OAuth2} instead
+ *
+ * @example
+ *
+ * ```ts
+ * OAuth2.create({
+ *   discoveryApi,
+ *   oauthRequestApi,
+ *   provider: {
+ *     id: 'auth0',
+ *     title: 'Auth0',
+ *     icon: () => null,
+ *   },
+ *   defaultScopes: ['openid', 'email', 'profile'],
+ *   environment: configApi.getOptionalString('auth.environment'),
+ * })
+ * ```
 */
 export default class Auth0Auth {
  static create(options: OAuthApiCreateOptions): typeof auth0AuthApiRef.T {