Craft Auth

const { auth } = MODULES;

Table of Contents

• verify
  • Parameters
• signIn
  • Parameters
• signUp
  • Parameters
• sendPasswordResetEmail
  • Parameters
• assignRoles
  • Parameters
• getIdToken
  • Parameters
• createCustomToken
  • Parameters
• signInWithCustomToken
  • Parameters
• createSessionCookie
  • Parameters
• verifySessionCookie
  • Parameters

verify

ID トークンを検証する

Parameters

• param object

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

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

signIn

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

Parameters

• param object

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

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

signUp

新規ユーザーを登録する

Parameters

• param object

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

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

sendPasswordResetEmail

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

Parameters

• param object

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

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

assignRoles

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

Parameters

• param object

  • param.uid string ユーザー ID
  • param.roles Array<string> 割り当てるロールの配列

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

getIdToken

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

Parameters

• param object

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

createCustomToken

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

Parameters

• param object

  • param.idToken string ID トークン

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

signInWithCustomToken

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

Parameters

• param object

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

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

createSessionCookie

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

Parameters

• param object

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

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

verifySessionCookie

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

Parameters

• param object

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

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