providers/auth0
Auth0Profile
使用 profile 回調時,從 Auth0 返回的使用者個人資料。 參考。
繼承
Record
<string
,any
>
屬性
app_metadata
app_metadata: object;
儲存有關使用者資訊的自訂欄位,這些資訊會影響使用者的存取權限,例如支援方案、安全角色(如果未使用授權核心功能集)或存取控制群組。若要深入了解,請閱讀中繼資料概觀。
blocked
blocked: boolean;
表示使用者是否已遭封鎖。匯入功能可讓訂閱者確保在遷移到 Auth0 時,使用者仍保持封鎖狀態。
created_at
created_at: Date;
指示使用者個人資料首次建立時間的時間戳記。
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;
}[];
包含從使用者最初進行身分驗證的身分提供者擷取的資訊。使用者也可以將其個人資料連結到多個身分提供者;這些身分也會顯示在這個陣列中。個別身分提供者物件的內容因提供者而異。在某些情況下,它也會包含要與提供者一起使用的 API 存取權杖。
last_ip
last_ip: string;
與使用者上次登入相關聯的 IP 位址。
last_login
last_login: Date;
指示使用者上次登入時間的時間戳記。如果使用者遭到封鎖並登入,封鎖的工作階段會更新 last_login。如果您從規則內使用 user< 物件使用此屬性,其值將與觸發規則的登入相關聯;這是因為規則會在登入後執行。
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;
指出使用者是否已驗證其電話號碼。僅適用於使用簡訊連線的使用者。
圖片
picture: string;
指向使用者個人資料圖片的網址。
子識別碼
sub: string;
使用者的唯一識別碼。
更新時間
updated_at: Date;
時間戳記,表示使用者個人資料上次更新/修改的時間。對 last_login 的變更會被視為更新,因此大多數情況下,updated_at 會與 last_login 相符。
使用者 ID
user_id: string;
(唯一)使用者的識別碼。匯入功能允許使用者記錄在多個系統間同步,而無需使用對應表。
使用者元數據
user_metadata: object;
自訂欄位,用於儲存有關使用者的資訊,這些資訊不會影響他們可以或不能存取的内容,例如工作地址、家庭地址或使用者偏好設定。若要了解更多資訊,請閱讀「元數據概述」。
使用者名稱
username: string;
(唯一)使用者的使用者名稱。
預設值()
default(config): OIDCConfig<Auth0Profile>
設定
回呼網址
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 提供者隨附預設組態。若要覆寫您的使用案例的預設值,請查看自訂內建 OAuth 提供者。
說明
如果您認為在預設組態中發現錯誤,您可以開啟問題。
Auth.js 嚴格遵守規範,且不對提供者偏離規範的行為負責。您可以開啟問題,但如果問題是不符合規範,我們可能不會尋求解決方案。您可以在討論區中請求更多協助。
參數
參數 | 類型 |
---|---|
config | OIDCUserConfig <Auth0Profile > |