providers/auth0

Auth0との統合による組み込みサインイン。

Auth0Profile

プロファイルコールバックを使用する際に Auth0 から返されるユーザープロファイル。リファレンス。

拡張

• Record<string, any>

プロパティ

app_metadata

app_metadata: object;

ユーザーのアクセスに影響を与えるユーザーに関する情報を格納するカスタムフィールド。サポートプラン、セキュリティロール（Authorization Core機能セットを使用していない場合）、アクセス制御グループなど。詳細については、メタデータ概要をお読みください。

blocked

blocked: boolean;

ユーザーがブロックされているかどうかを示します。インポートにより、サブスクライバーは Auth0 に移行する際にユーザーがブロックされたままになるようにすることができます。

created_at

created_at: Date;

ユーザープロファイルが最初に作成されたときのタイムスタンプ。

email

email: string;

(一意) ユーザーのメールアドレス。

email_verified

email_verified: boolean;

ユーザーがメールアドレスを確認したかどうかを示します。

family_name

family_name: string;

ユーザーの姓。

given_name

given_name: string;

ユーザーの名。

identities

identities: {
[key: string]: any;   connection: string;
  isSocial: boolean;
  profileData: object;
  provider: string;
  user_id: string;
  }[];

ユーザーが最初に認証した ID プロバイダーから取得した情報が含まれます。ユーザーは、複数の ID プロバイダーにプロファイルをリンクすることもできます。それらの ID もこの配列に表示されます。個々の ID プロバイダーオブジェクトの内容は、プロバイダーによって異なります。場合によっては、プロバイダーで使用する API アクセストークンも含まれます。

last_ip

last_ip: string;

ユーザーの最後のログインに関連付けられた IP アドレス。

last_login

last_login: Date;

ユーザーが最後にログインしたときのタイムスタンプ。ユーザーがブロックされてログインした場合、ブロックされたセッションによって last_login が更新されます。ユーザーオブジェクトを使用してルール内からこのプロパティを使用している場合、その値はルールをトリガーしたログインに関連付けられます。これは、ルールがログイン後に実行されるためです。

last_password_reset

last_password_reset: Date;

ユーザーのパスワードが最後にリセット/変更されたときのタイムスタンプ。ユーザーの作成時には、このフィールドは存在しません。このプロパティは、データベース接続でのみ利用可能です。

logins_count

logins_count: number;

ユーザーがログインした回数。ユーザーがブロックされてログインした場合、ブロックされたセッションは logins_count にカウントされます。

multifactor

multifactor: string;

ユーザーが登録されている多要素プロバイダーのリスト。

name

name: string;

ユーザーのフルネーム。

nickname

nickname: string;

ユーザーのニックネーム。

phone_number

phone_number: string;

ユーザーの電話番号。SMS接続のユーザーに対してのみ有効です。

phone_verified

phone_verified: boolean;

ユーザーが電話番号を確認したかどうかを示します。SMS接続のユーザーに対してのみ有効です。

picture

picture: string;

ユーザーのプロファイル画像への URL。

sub

sub: string;

ユーザーの一意の識別子。

updated_at

updated_at: Date;

ユーザーのプロファイルが最後に更新/変更されたときのタイムスタンプ。last_loginへの変更は更新と見なされるため、ほとんどの場合、updated_atはlast_loginと一致します。

user_id

user_id: string;

(一意) ユーザーの識別子。インポートにより、マッピングテーブルを使用せずに、複数のシステム間でユーザーレコードを同期できます。

user_metadata

user_metadata: object;

ユーザーのアクセスに影響を与えないユーザーに関する情報を格納するカスタムフィールド。勤務先住所、自宅住所、ユーザー設定など。詳細については、メタデータ概要をお読みください。

username

username: string;

(一意) ユーザーのユーザー名。

default()

default(config): OIDCConfig<Auth0Profile>

セットアップ

コールバックURL

https://example.com/api/auth/callback/auth0

設定

import { Auth } from "@auth/core"
import Auth0 from "@auth/core/providers/auth0"
 
const request = new Request(origin)
const response = await Auth(request, {
  providers: [
    Auth0({
      clientId: AUTH0_ID,
      clientSecret: AUTH0_SECRET,
    }),
  ],
})

リソース

• Auth0ドキュメント

注記

Auth0プロバイダーには、デフォルト構成が付属しています。ユースケースに合わせてデフォルトをオーバーライドするには、組み込みの OAuth プロバイダーのカスタマイズをご確認ください。

ヘルプ

デフォルト設定にバグがあると思われる場合は、Issue をオープンしてください。

Auth.js は仕様に厳密に従っており、プロバイダーによる仕様からの逸脱については責任を負いかねます。Issue をオープンすることはできますが、問題が仕様に準拠していない場合は、解決を追求しない可能性があります。Discussions でさらにヘルプを求めることができます。

パラメータ

戻り値

OIDCConfig<Auth0Profile>