@8base/auth 中文文档教程

Question

8base SDK - Auth Module

8base SDK 提供了一种在您的客户端应用程序中实施身份验证的简单方法。 无论您使用的是 8base 身份验证、Auth0 还是 OpenID 提供商，Auth 模块都有助于管理身份验证流程。

有关 Auth 的更多信息，请参考文档。

Parameters

• strategy string Auth strategy.
• storageOptions
  • storage Kind of storage for auth(window.localStorage by default)
  • storageKey Key to save auth data (auth by default)
  • initialState Initial auth state
• subscribable boolean Is auth client should be subscribable

Usage

Auth 模块公开了几种不同的身份验证策略。 这些可以声明为字符串或作为 AUTH_STRATEGIES 从 SDK 导入。 Auth.createClient 函数接受两个配置对象，它根据给定策略生成一个 authClient 实例化对象。

一些必需的值包括：

Auth Strategies

当前 SDK 支持多种不同的可用身份验证策略。 它们是：

AUTH_STRATEGIES {
  WEB_8BASE = 'web_8base',
  WEB_AUTH0 = 'web_auth0',
  WEB_OAUTH = 'web_oauth',
  API_TOKEN = 'api_token',
}

WEB_8BASE and WEB_AUTH0 Example

要使用WEB_8BASE 或WEB_AUTH0 策略初始化一个新的authClient，请参考以下配置。

domain, clientId, logoutUrl, redirectUri 可以从 身份验证配置文件 在 8base 管理控制台中创建。

import { Auth, AUTH_STRATEGIES } from "@8base/auth";
/**
 * Creating an Authentication Profile in 8base will provide 
 * you with a Client ID and Domain.
 */
const domain = 'authentication-profile.auth.domain';
const clientId = 'authentication-profile-client-id';
/**
 * The redirect and logout URIs are all configured in the 
 * authentication profile that gets set up in the 8base
 * management console.
 */
const logoutRedirectUri = `${window.location.origin}/logout`;
const redirectUri = `${window.location.origin}/auth/callback`;
/**
 * There are multiple auth strategies that can be 
 * used when using 8base. By default, specifying
 * 'web_8base' will configure the 8base auth client.
 */
const authClient = Auth.createClient(
  {
    strategy: AUTH_STRATEGIES['STRATEGY_NAME']
  },
  {
    domain,
    clientId,
    redirectUri,
    logoutRedirectUri
  }
);

API_TOKEN Example

要使用API_TOKEN 策略初始化一个新的authClient，请参考以下配置。

import { Auth } from "@8base/auth";
/**
 * Set the API token generated in 8base management console.
 */
const apiToken = "8base-api-token";
/**
 * Specify the strategy and API token.
 */
export default Auth.createClient(
  {
    strategy: "api_token"
  },
  {
    apiToken
  }
);

WEB_OAUTH Firebase Example

import firebase from 'firebase';
import { Auth } from "@8base/auth";

const FIREBASE_CONFIGURATION = {
  apiKey: "",
  authDomain: "",
  databaseURL: "",
  projectId: "",
  storageBucket: "",
  messagingSenderId: "",
  appId: ""
};

const firebaseAuth = firebase.initializeApp(FIREBASE_CONFIGURATION).auth();

export default Auth.createClient(
  {
    strategy: "web-oauth"
  },
  {
    authorize (email, password) {
      return firebaseAuth.signInWithEmailAndPassword(
        email,
        password,
      )
        .then(() => firebaseAuth.currentUser.getIdToken())
        .then((token) => {
          return token;
        })
      },
    logout() {
      window.addEventListener('unload', () => {
        this.purgeState();
      });

      window.location.href = '/';
    }
  }
);

Documentation

使用 SDK 的 Auth 模块的一个重要部分是在管理控制台中正确配置身份验证配置文件。 请参阅身份验证配置文件文档以了解所需的步骤。

使用 userLogin 和 signUpUserWithPassword 突变，自定义身份验证流程在 8base 中是 100% 可能的。 但是，当前的策略非常适合通过身份验证快速启动和运行用户，我们将继续改进当前可用的身份验证策略。