コンテンツにスキップ

Craft Auth

const { auth } = MODULES;

ID トークンを検証する

  • param object

    • param.idToken string 検証する ID トークン

Returns Promise<{user: object, idToken: string}> 検証結果(ユーザー情報と ID トークン)

メールアドレスとパスワードでサインインする

  • param object

    • param.email string メールアドレス
    • param.password string パスワード(6 文字以上)

Returns Promise<{user: object, idToken: string, refreshToken: string, expiresIn: string}> サインイン結果

新規ユーザーを登録する

  • param object

    • param.email string メールアドレス
    • param.password string パスワード(6 文字以上)

Returns Promise<{user: object, idToken: string, refreshToken: string, expiresIn: string}> 登録結果

パスワードリセットメールを送信する

  • param object

    • param.email string パスワードリセットメールを送信するメールアドレス

Returns Promise<{success: boolean, message: string, email: string}> 送信結果

ユーザーにロールを割り当てる

Returns Promise<{uid: string, roles: Array<string>}> 割り当て結果

リフレッシュトークンから新しい ID トークンを取得する

  • param object

    • param.refreshToken string リフレッシュトークン

ID トークンからカスタムトークンを生成する

Returns Promise<{customToken: string}> カスタムトークン

カスタムトークンでサインインする

  • param object

    • param.customToken string カスタムトークン

Returns Promise<{user: object, idToken: string, refreshToken: string, expiresIn: string}> サインイン結果

セッションクッキーを作成する

  • param object

    • param.idToken string ID トークン
    • param.expiresIn number 有効期限(ミリ秒、最大 14 日)

Returns Promise<{sessionCookie: string, expiresIn: number}> セッションクッキー

セッションクッキーを検証する

  • param object

    • param.sessionCookie string セッションクッキー
    • param.checkRevoked boolean 取り消し確認(デフォルト: true)

Returns Promise<{user: object}> ユーザー情報