Package google.cloud.identitytoolkit.v1

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

int32

這是必要旗標，所需雜湊長度 (以位元組為單位)。最小值為 4，最大值為 1024。

HashType

這是必要旗標，不得為 HASH_TYPE_UNSPECIFIED。

int32

這是必要旗標，平行處理作業程度，也稱為執行緒或車道。最少 1 個，最多 16 個。

int32

這是必要旗標，要執行的疊代次數。最少 1 個，最多 16 個。

int32

這是必要旗標，以千字節為單位的記憶體成本。上限為 32768。

Version

Argon2 演算法的版本。如未指定，預設值為 VERSION_13。

bytes

如果提供額外的相關資料，系統會附加至雜湊值，提供額外的安全防護。如果是透過 JSON 指定的值，則為 Base64 編碼的字串。

string

如果指定 tenant_id，則為 Identity Platform 租用戶所屬 Google Cloud 專案的 ID。否則，則為帳戶所屬 Google Cloud 專案的 ID。

授權需要指定資源 targetProjectId 的下列 IAM 權限：

• firebaseauth.users.delete

string

這是必要旗標，要刪除的使用者 ID 清單。

bool

是否強制刪除未停用的帳戶。如果為 false，系統只會刪除已停用的帳戶，並將未停用的帳戶新增至 errors。

string

如果帳戶屬於 Identity Platform 租戶，則為租戶的 ID。如果帳戶屬於預設 Identity Platform 專案，則不需要這個欄位。

BatchDeleteErrorInfo

無法刪除的帳戶詳細錯誤資訊。

int32

原始 local_ids 欄位中錯誤項目的索引。

string

對應的使用者 ID。

string

詳細的錯誤訊息。

string

要擷取相關供應商的使用者帳戶電子郵件 ID。必須設定至少一個 identifier 和 provider_id 欄位。

電子郵件地址的長度不得超過 256 個半形字元，格式為 [email protected]。電子郵件地址也應符合 RFC 822 addr-spec 產生內容。

string

IdP 將使用者重新導向的有效網址。網址不得含有片段或保留的 state 查詢參數。

string

string

使用者用於登入的 IdP 供應器 ID。這應該是已啟用登入功能的供應商 ID，可從預設支援的 IdP清單中找到，或採用 oidc.* 或 saml.* 格式。例如 google.com、facebook.com、oidc.testapp 和 saml.testapp。必須設定至少一個 identifier 和 provider_id 欄位。

string

string

其他以空格分隔的 OAuth 2.0 範圍，用於指定與 IdP 的驗證要求範圍。用於 OAuth 2.0 IdP。

如果是 Google 供應器，則會在設定這個欄位時使用授權碼流程。

string

不透明字串，用於在驗證要求和 IdP 的回呼之間維持背景資訊。

string

string

string

用於 Google 供應器。使用者的 G Suite 代管網域，用於限制登入該網域的使用者。

string

可在 SignInWithIdp 中驗證的工作階段 ID，以防範工作階段固定攻擊。如果未提供，系統會產生隨機字串，並以工作階段 ID 的形式傳回。

string

用於 Google 供應器。要使用的驗證流程類型。如果存在，則應為 CODE_FLOW，以便指定授權碼流程。否則會使用預設的 ID 權杖流程。

map<string, string>

要新增至授權 URI 的其他自訂查詢參數。下列參數為保留參數，無法新增：client_id、response_type、scope、redirect_uri、state。

針對 Microsoft 提供者，您可以在 tenant 自訂參數中指定要登入的 Azure AD 租用戶。

string

要建立授權 URI 或查詢電子郵件 ID 的 Identity Platform 租戶 ID。如果未設定，系統會在專案中的預設 Identity Platform 例項中執行這項作業。

string

string

要求的供應商授權 URI。只有在要求中設定了供應商 ID 時才會顯示。

string

bool

電子郵件 ID 是否代表現有帳戶。只有在要求中設定電子郵件 ID 時才會出現。

string

來自要求的提供者 ID (如有提供)。

bool

指出使用者是否曾以要求中的提供者 ID 登入。只有在要求中設定已註冊的電子郵件 ID 時才會出現。

bool

使用者嘗試登入失敗次數過多，是否需要輸入人機驗證。只有在要求中設定已註冊的電子郵件 ID 時才會出現。

string

要求中的會話 ID，如果沒有，則為 CreateAuthUri 產生的隨機字串。可用來防範工作階段固定攻擊。

string

使用者先前使用的登入方式清單。每個元素都是 password、emailLink 或 IdP 的供應商 ID 之一。只有在要求中設定已註冊的電子郵件 ID 時才會出現。如果啟用電子郵件列舉防護，這個方法會傳回空白清單。

string

這是必要旗標，有效的 Identity Platform ID 權杖。

int64

工作階段 Cookie 到期前的秒數。以秒為單位指定時間長度，範圍為 5 分鐘至 14 天 (含兩者)。

string

帳戶所屬專案的 ID。

string

帳戶所屬 Identity Platform 租戶的租戶 ID。

string

根據要求中指定的 Identity Platform ID 權杖建立的工作階段 Cookie。其格式為 JSON Web Token (JWT)。一律會顯示。

string

要刪除的使用者帳戶 ID。如要指定這個欄位，您必須具備具備適當權限的 Google OAuth 2.0 憑證。缺少憑證的使用者應改為傳送 ID 權杖。

int64

string

要刪除的帳戶的 Identity Platform ID 權杖。對於缺少 Google OAuth 2.0 憑證的使用者所提出的要求，必須指定此屬性。驗證要求中如果包含具備適當權限的 Google OAuth2 憑證，則可以傳遞 local_id，以便指定要刪除的帳戶。

string

帳戶所屬租用戶的 ID (如適用)。只有在經過驗證的請求中，如果有 Google OAuth 2.0 憑證，並指定屬於 Identity Platform 租用戶的帳戶 local_id，才需要指定此值。

string

帳戶所屬專案的 ID。僅應在指定帳戶 local_id 的驗證要求中指定。

授權需要指定資源 targetProjectId 的下列 IAM 權限：

• firebaseauth.users.delete

string

int64

string

先前要求回應中的分頁符記。

int32

要傳回的結果數上限。下限值為 1，上限值為 1000。預設值為 20。

string

如果指定 tenant_id，則為 Identity Platform 租用戶所屬 Google Cloud 專案的 ID。否則，則為帳戶所屬 Google Cloud 專案的 ID。

授權需要指定資源 targetProjectId 的下列 IAM 權限：

• firebaseauth.users.get

string

帳戶所屬的 Identity Platform 租用戶 ID。如未指定，系統會傳回 Identity Platform 專案中的帳戶。

string

UserInfo

屬於專案/租用戶的所有帳戶，受限於要求中的 max_results。

string

如果還有其他帳戶需要下載，則可傳回至 DownloadAccount 的符記，以便取得更多帳戶。否則，此欄為空白。

string

應傳送多重認證驗證碼的電子郵件地址。

bool

是否停用範本。如果為 true，系統會使用預設範本。

string

電子郵件寄件地址

string

電子郵件內文

string

電子郵件主旨

string

起點顯示名稱

EmailBodyFormat

電子郵件內文格式

string

回覆地址

string

寄件者地址的本機部分

string

值採用 III 語言代碼格式 (例如「zh-CN」、「es」)。系統接受「-」和「_」分隔符。

bool

電子郵件內文或主旨是否為自訂內容。

int32

項目的索引，範圍為 [0, request.size - 1]

string

詳細的錯誤訊息

string

要擷取的帳戶 Identity Platform ID 權杖。必須為使用者提出的要求指定此值。

string

要擷取的一或多個帳戶 ID。只有具備 Google OAuth 2.0 憑證且具有適當權限的已驗證要求，才能指定此屬性。

string

要擷取的一或多個帳戶的電子郵件地址。電子郵件長度不得超過 256 個半形字元，格式為 [email protected]。電子郵件也應符合 RFC 822 的 addr-spec 產生方式。應僅由開發人員透過經過驗證的要求指定。

int64

string

要擷取的一或多個帳戶的電話號碼。應僅由開發人員透過經過驗證的要求指定，且應採用 E.164 格式，例如 +15555555555。

FederatedUserIdentifier

string

帳戶所屬租用戶的 ID。應僅由開發人員透過經過驗證的要求指定。

string

由 tenant_id 指定的帳戶或 Identity Platform 租用戶所屬的 Google Cloud 專案 ID。只有具備 Google OAuth 2.0 憑證且具有適當權限的已驗證要求，才能指定此參數。

授權需要指定資源 targetProjectId 的下列 IAM 權限：

• firebaseauth.users.get

string

要擷取的一或多個帳戶的初始電子郵件。電子郵件長度不得超過 256 個半形字元，格式為 [email protected]。電子郵件也應符合 RFC 822 的 addr-spec 產生方式。應僅由開發人員透過經過驗證的要求指定。

string

支援的識別資訊提供者的 ID。這應該是已啟用登入功能的供應商 ID，可從預設支援的 IdP清單中找到，或採用 oidc.* 或 saml.* 格式。例如 google.com、facebook.com、oidc.testapp 和 saml.testapp。

string

provider_id 指定的第三方識別資訊提供者帳戶使用者 ID。

string

UserInfo

與要求中參數相符的特定使用者帳戶資訊。

OobReqType

這是必要旗標，要傳送的非頻道 (OOB) 碼類型。視這個值而定，這項要求中的其他欄位將為必填欄位，且/或具有不同的含義。系統可傳送 4 種不同的 OOB 驗證碼：* PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL

string

要傳送 OOB 代碼的帳戶電子郵件地址，通常是需要更新的帳戶電子郵件地址。此參數適用於 PASSWORD_RESET、EMAIL_SIGNIN 和 VERIFY_EMAIL。只有在 return_oob_link 設為 true 時，才需要提供 VERIFY_AND_CHANGE_EMAIL 要求。在本例中，這會是使用者的原始電子郵件地址。

string

string

對於 PASSWORD_RESET 要求，如果系統偵測到可能的濫用活動，就必須提供 reCaptcha 回應。在這種情況下，這是 reCAPTCHA 驗證問題的回應，用於驗證呼叫端。

string

呼叫端的 IP 位址。只有 PASSWORD_RESET 要求需要提供。

string

帳戶更新後的電子郵件地址。僅適用於 VERIFY_AND_CHANGE_EMAIL 要求。

string

帳戶的 ID 權杖。除非 return_oob_link 設為 true，否則必須為 VERIFY_AND_CHANGE_EMAIL 和 VERIFY_EMAIL 要求提供。

string

使用者點選電子郵件中傳送的連結後，要繼續執行的網址。這個網址可讓網頁小工具處理 OOB 代碼。

string

如果相關聯的 iOS 應用程式可以處理 OOB 代碼，則為該應用程式的 iOS 軟體包 ID。這樣一來，如果已安裝正確的應用程式，系統就會開啟該應用程式。

string

如果相關聯的 iOS 應用程式可以處理 OOB 代碼，則為該應用程式的 App Store ID。這樣一來，如果應用程式尚未安裝，App Store 就會開啟正確的應用程式。

string

如果相關聯的 Android 應用程式可以處理 OOB 代碼，則在使用此 OOB 代碼時，會處理回呼的 Android 應用程式 Android 套件名稱。這樣一來，系統就能開啟正確的應用程式 (如果已安裝)，或開啟 Google Play 商店，讓使用者安裝正確的應用程式。

bool

如果相關聯的 Android 應用程式可以處理 OOB 程式碼，則在開啟連結的裝置上安裝 Android 應用程式 (如果尚未安裝)。

string

如果相關聯的 Android 應用程式可處理 OOB 代碼，則為應用程式的最低版本。如果裝置上的版本低於此版本，使用者就會前往 Google Play 商店升級應用程式。

bool

如果設為 true，系統會以通用連結或 Android 應用程式連結傳送 OOB 程式碼連結，並由已安裝的對應應用程式開啟。如果未設定或設為 false，系統會先將 OOB 代碼傳送至網頁小工具，然後在繼續時將重新導向至已安裝的應用程式。

string

帳戶所屬 Identity Platform 租戶的租戶 ID。

string

帳戶所屬 Identity Platform 專案的專案 ID。如要指定這個欄位，您必須具備具備適當權限的 Google OAuth 2.0 憑證。

授權需要指定資源 targetProjectId 的下列 IAM 權限：

• firebaseauth.users.sendEmail

string

為確保使用者可輕鬆在 iOS 或 Android 中開啟所用網址，我們會建立 Firebase 動態連結。大多數 Identity Platform 專案只會啟用一個 Dynamic Link 網域，因此可以將這個欄位留空。這個欄位包含指定的動態連結網域，適用於啟用多個動態連結的專案。

bool

是否應在回應中傳回包含 OOB 代碼的確認連結 (不會傳送電子郵件)。開發人員想自行建構電子郵件範本並傳送時使用。根據預設，這個值為 false。如要指定這個欄位並將其設為 true，您必須具備 Google OAuth 2.0 憑證，並擁有適當的權限

ClientType

用戶端類型：網頁、Android 或 iOS。啟用 reCAPTCHA Enterprise 防護功能時必須提供。

RecaptchaVersion

captcha_response 中 reCAPTCHA 權杖的 reCAPTCHA 版本。

string

(非必要) 為確保使用的網址可輕鬆在 iOS 或 Android 中開啟，我們會建立代管連結「/__/auth/links」。這個選用欄位包含建構託管連結時要使用的網域。如果未設定，系統會使用「.firebaseapp.com」網域。

string

string

如果要求中的 return_oob_link 為 true，則傳送的 OOB 代碼。

string

如果要求中的 return_oob_link 為 false，則為驗證連結傳送至的電子郵件地址。

string

如果請求中的 return_oob_link 為 true，則會傳送至使用者的 OOB 連結。這會傳回已建構的連結，其中包含 Firebase Dynamic Link 相關參數。

int64

委派專案要求的專案編號。這個欄位僅應用於 Firebase 1.0 遷移作業。

int64

要擷取的設定專案編號。這個欄位已淘汰，新整合項目不應使用。

bool

是否應傳回動態連結。

string

要與實際 Android 套件名稱進行比對的 Android 套件名稱。如果您提供這個欄位，但未提供 sha1_cert_hash，且這個欄位不符合實際的 Android 套件名稱，則動作會擲回錯誤。

string

iOS 軟體包 ID，用於比對實際的 iOS 軟體包 ID。如果提供這個欄位，如果這個欄位不符合實際的 iOS 套件 ID，這個動作就會擲回錯誤。

string

RP OAuth 用戶端 ID。如果已設定，系統會執行檢查，確保 OAuth 用戶端適用於擷取的專案，如果不符合要求，則會拒絕要求並顯示用戶端錯誤。

string

SHA-1 Android 應用程式憑證雜湊。如果已設定，系統會執行檢查，確保憑證雜湊值對於擷取的專案和 android_package_name 有效。

string

Firebase 應用程式 ID (適用於使用 Firebase 的應用程式)。您可以在專案的 Firebase 控制台中找到這項資訊。如果已設定，系統會執行檢查，確保應用程式 ID 適用於擷取的專案。如果無效，系統會拒絕要求，並傳回用戶端錯誤。

string

擷取的設定專案 ID。

string

Google Cloud API 金鑰這個欄位只會傳回開發人員的已驗證呼叫。

bool

是否允許使用密碼帳戶註冊。這個欄位只會傳回開發人員的已驗證呼叫。

IdpConfig

OAuth2 提供者設定。這個欄位只會傳回開發人員的已驗證呼叫。

string

小工具重新導向的授權網域。

bool

是否啟用匿名使用者。這個欄位只會傳回開發人員的已驗證呼叫。

string

Firebase Dynamic Links 網域，用於建立連結，將使用者重新導向至原生應用程式。

bool

是否使用電子郵件傳送。這個欄位只會傳回開發人員的已驗證呼叫。

EmailTemplate

密碼重設電子郵件範本。這個欄位只會傳回開發人員的已驗證呼叫。

EmailTemplate

驗證電子郵件的電子郵件範本。這個欄位只會傳回開發人員的已驗證呼叫。

EmailTemplate

變更電子郵件的電子郵件範本。這個欄位只會傳回開發人員的已驗證呼叫。

EmailTemplate

舊版 Firebase V1 應用程式的密碼重設電子郵件範本。這個欄位只會針對開發人員的已驗證呼叫傳回。

EmailTemplate

用於撤銷新增第二個驗證方法的電子郵件範本。這個欄位只會傳回開發人員的已驗證呼叫。

string

string

string

用於叫用 reCAPTCHA 服務的 reCAPTCHA v2 網站金鑰。一律會出現。

string

用來產生 PIA 權杖的生產者專案編號

OpenIdConnectKey

工作階段 Cookie 簽署者的公開金鑰，格式為 JSON Web Keys (JWK)。

Provider

bool

如果允許使用者透過提供者登入，則值為「是」。

int32

系統會提示/重新導向使用者聯合登入此 IdP 的百分比

string

OAuth2 用戶端 ID。

string

OAuth2 用戶端密鑰。

string

用戶端 ID 已加入許可清單，可進行目標對象檢查。

string

信賴憑證者 ID，也就是已發出 SAMLResponse 的目標對象。

string

Identity Platform ID 權杖。系統會驗證這項資訊，然後轉換為新的 SAMLResponse。

string

為每個應用程式在 Google 管理控制台中指定的 SAML 應用程式實體 ID。如果開發人員想要重新導向至第三方應用程式，而非 G Suite 應用程式，就可能需要這個值。使用時，我們會傳回 RelayState。這包括 SAMLRequest，可用於觸發由服務提供者啟動的 SAML 流程，將使用者重新導向至實際應用程式。

string

為信賴方建立的已簽署 SAMLResponse。

string

使用傳回 SAMLResponse 的 ACS 端點。

string

產生的 RelayState。

string

使用者的電子郵件地址。

string

使用者的名字。

string

使用者的姓氏。

bool

這項要求是否建立登入使用者。

string

這項 MFA 選項的 ID。

string

這個 MFA 選項的顯示名稱，例如「公司手機」。

Timestamp

帳戶註冊這項第二重驗證條件的時間戳記。

string

通常會顯示與這項註冊相關聯的電話號碼。在某些情況下 (例如在第一個因素登入後)，系統只會顯示相關聯的電話號碼的模糊處理版本。

TotpInfo

包含 TOTP MFA 專屬資訊。

EmailInfo

包含電子郵件多重認證機制相關資訊。

string

僅供輸出。未經模糊處理的 phone_info。

string

鍵類型。

string

簽名演算法。

string

使用金鑰。

string

用於識別此鍵的專屬字串。

string

RSA 公開金鑰的模數，以 Base64url 編碼表示值的大端序表示法。

string

RSA 公開金鑰的指數，以 Base64url 編碼表示值的大端序表示法。

string

識別資訊提供者的 ID。

string

使用者在 Identity Provider 中的顯示名稱。

string

使用者在識別資訊提供者中的個人資料相片網址。

string

使用者在 Identity Provider 中的 ID。

string

使用者在身分識別提供者中的電子郵件地址。

string

直接由 Identity Provider 傳回的使用者原始 ID。

string

使用者在 Twitter 上的 screen_name，或在 GitHub 上的登入名稱。

string

使用者在身分識別提供者中的電話號碼。

bool

如果為 true，這項要求會傳回符合查詢的帳戶。如果 false，系統只會傳回符合查詢的帳戶數量。預設值為 true。

int64

傳回的帳戶數量上限為 500。預設值為 500。只有在 return_user_info 設為 true 時才有效。

int64

從相符記錄的開頭略過的帳戶數量。只有在 return_user_info 設為 true 時才有效。

SortByField

Order

string

結果的專案範圍 ID。

授權需要指定資源 targetProjectId 的下列 IAM 權限：

• firebaseauth.users.get

string

結果的範圍所屬租用戶 ID。

SqlExpression

string

不區分大小寫的字串，帳戶的電子郵件必須與此相符。SqlExpression 中只能指定 email、phone_number 或 user_id 其中一個。如果指定多個，系統只會套用第一個 (依順序)。

string

帳戶的本機 ID 應相符的字串。SqlExpression 中應只指定 email、phone_number 或 user_id 其中一個，如果指定多個，系統只會套用第一個 (依序)。

string

帳戶的電話號碼應與此字串相符。SqlExpression 中只能指定 email、phone_number 或 user_id 其中一個。如果指定多個，系統只會套用第一個 (依順序)。

int64

如果要求中的 return_user_info 為 true，則這是此訊息中傳回的帳戶數量。否則，這會是符合查詢的帳戶總數。

UserInfo

如果要求中的 return_user_info 為 true，表示這是符合查詢的帳戶。

string

由 GetOobCode 要求產生的頻外 (OOB) 程式碼。只要指定這個參數 (或只指定這個參數和租用戶 ID)，即可在回應中取得非頻道外程式碼的類型，而不會變更帳戶狀態。這個方法只能用來使用 PASSWORD_RESET 外部代碼。

string

要為這個帳戶設定的新密碼。指定這個欄位會導致帳戶變更，並使用非頻道代碼 (如果指定了 PASSWORD_RESET 類型的代碼)。

string

要修改的帳戶目前密碼。指定這個值和電子郵件地址，即可變更帳戶密碼，而不需要使用額外的驗證碼。

string

(非必要) 要修改的帳戶電子郵件地址。請指定這項資訊和舊密碼，即可變更帳戶密碼，而無須使用額外驗證碼。

string

(非必要) 帳戶所屬 Identity Platform 租戶的租戶 ID。

string

string

與所用外部驗證碼相關聯的電子郵件地址。

string

OobReqType

MfaEnrollment

string

傳送驗證碼的電話號碼，格式為 E.164。

string

收到 iOS 應用程式權杖驗證成功的通知。如果您未使用「captcha_response」(未啟用 reCAPTCHA Enterprise)，就必須指定至少一個 (ios_receipt 和 ios_secret)、recaptcha_token 或 safety_net_token，以便驗證驗證碼是代表實際應用程式而非模擬器傳送。這項資訊應來自 [verifyIosClient][v1.accounts.verifyIosClient] 的回應。如果有，呼叫端也應在 x-ios-bundle-identifier 標頭中提供 ios_secret 和軟體包 ID，且該 ID 必須與 [verifyIosClient][v1.accounts.verifyIosClient] 要求中的軟體包 ID 相符。

string

密鑰以推播通知的形式傳送至 iOS 應用程式。應搭配 ios_receipt 和 x-ios-bundle-identifier 標頭傳遞。

string

應用程式驗證的 reCAPTCHA 權杖。如果您未使用「captcha_response」(未啟用 reCAPTCHA Enterprise)，就必須指定至少一個 (ios_receipt 和 ios_secret)、recaptcha_token 或 safety_net_token，以便驗證驗證碼是代表實際應用程式而非模擬器傳送。您應呼叫 [getRecaptchaParams][v1.getRecaptchaParams] 產生 recaptcha，並在使用者完成 recaptcha 驗證後產生 recaptcha 權杖。

string

使用者要登入的 Identity Platform 租用戶 ID。

AutoRetrievalInfo

僅限 Android 裝置。Google Play 服務會使用這項參數，識別要自動擷取的應用程式。

string

僅限 Android 裝置。用於代替 recaptcha 權杖，宣告應用程式身分。如果您未使用「captcha_response」(未啟用 reCAPTCHA Enterprise)，就必須指定至少一個 (ios_receipt 和 ios_secret)、recaptcha_token 或 safety_net_token，以便驗證驗證碼是代表實際應用程式而非模擬器傳送。您可以透過 SafetyNet Android Attestation API 產生 SafetyNet 權杖，並將 phone_number 欄位的 Base64 編碼做為 Nonce。

string

僅限 Android 裝置。用於代替 recaptcha 權杖 (和 safety_net_token)，宣告應用程式身分。如果您未使用「captcha_response」(未啟用 reCAPTCHA Enterprise)，就必須指定至少一種 (ios_receipt 和 ios_secret)、recaptcha_token 或 play_integrity_token，以便驗證驗證碼是代表實際應用程式而非模擬器傳送。您可以透過 PlayIntegrity API 產生 Play Integrity 權杖，方法是將 SHA256 套用至 phone_number 欄位做為 Nonce。

string

(非必要) reCAPTCHA 用戶端整合功能提供的 reCAPTCHA Enterprise 權杖。啟用 reCAPTCHA Enterprise 時必須提供。

ClientType

(非必要) 用戶端類型 (網頁、Android 或 iOS)。啟用 reCAPTCHA Enterprise 時必須提供。

RecaptchaVersion

(非必要) captcha_response 中 reCAPTCHA 權杖的 reCAPTCHA 版本。啟用 reCAPTCHA Enterprise 時必須提供。

string

Android 應用程式針對 Google Play 服務的 SMS Retriever API 所用的簽署雜湊。

string

已加密的工作階段資訊。這項資訊可用於 [signInWithPhoneNumber][v1.accounts.signInWithPhoneNumber] 驗證電話號碼。

string

有效的 Identity Platform ID 權杖。嘗試變更使用者相關資訊時，必須提供此權限。

string

使用者的 ID。如要指定這個欄位，您必須具備具備適當權限的 Google OAuth 2.0 憑證。如果是來自使用者的請求，則應改為傳遞 ID 權杖。

string

使用者的新顯示名稱，會在帳戶屬性中更新。顯示名稱的長度不得超過 256 個半形字元。

string

使用者的新電子郵件地址，將更新至帳戶的屬性。電子郵件長度不得超過 256 個半形字元，格式為 [email protected]。電子郵件也必須符合 RFC 822 的 addr-spec 產生方式。如果啟用電子郵件列舉保護，使用者必須先驗證電子郵件，才能變更電子郵件，但管理員可以變更電子郵件。

string

使用者的新密碼，會在帳戶屬性中更新。密碼長度至少須為 6 個字元。

string

帳戶應連結的身分驗證方。

string

要套用至使用者帳戶的額外代碼。支援下列非正式驗證碼類型：* VERIFY_EMAIL * RECOVER_EMAIL * REVERT_SECOND_FACTOR_ADDITION * VERIFY_AND_CHANGE_EMAIL

bool

使用者的電子郵件是否已經驗證。如要指定這個欄位，您必須具備具備適當權限的 Google OAuth 2.0 憑證。

bool

帳戶是否應僅限使用聯合登入。

string

string

reCAPTCHA 驗證問題的回應。系統偵測到可能的濫用活動時，必須提供這項資訊。

int64

指定 Identity Platform ID 權杖最短的有效時間戳記 (以秒為單位)。

bool

如果為 true，表示帳戶已停用，使用者將無法再登入。

string

int64

string

使用者新的相片網址，用於更新帳戶的個人資料相片。網址長度不得超過 2048 個半形字元。

UserAttributeName

bool

是否傳回 ID 和重新整理權杖。應一律為 true。

string

取消連結使用者帳戶的 ID 提供者。

int64

帳戶上次登入的時間戳記，以毫秒為單位。

int64

帳戶建立時間的時間戳記 (以毫秒為單位)。

string

要在帳戶屬性中更新的電話號碼。

string

以 JSON 格式儲存的 Identity Platform ID 權杖中自訂屬性。如要指定這個欄位，您必須具備具備適當權限的 Google OAuth 2.0 憑證。

string

帳戶所屬 Identity Platform 租戶的租戶 ID。使用者端的要求應傳遞 Identity Platform ID 權杖，而非設定此欄位。

string

帳戶所屬專案的專案 ID。如要指定這個欄位，您必須具備 Google OAuth 2.0 憑證，並擁有適當的權限。來自使用者的請求應改為傳遞 Identity Platform ID 權杖。

授權需要指定資源 targetProjectId 的下列 IAM 權限：

• firebaseauth.users.update

MfaInfo

在使用者帳戶中設定的多重驗證相關資訊。這項操作會覆寫帳戶中先前任何與多重驗證相關的資訊。如要指定這個欄位，您必須具備具備適當權限的 Google OAuth 2.0 憑證。

ProviderUserInfo

要連結至使用者帳戶的供應商。如要指定這個欄位，您必須具備具備適當權限的 Google OAuth 2.0 憑證。

MfaEnrollment

使用者註冊的第二重驗證。

string

string

已驗證使用者的 ID。

string

帳戶的電子郵件地址。

string

帳戶的顯示名稱。

string

帳戶的 Identity Platform ID 權杖。這項屬性用於舊版使用者註冊。

ProviderUserInfo

帳戶中已連結的識別資訊提供者。

string

使用者帳戶屬性中已設定的新電子郵件地址。

string

使用者個人資料相片的網址。

string

帳戶的更新權杖。這項屬性用於舊版使用者註冊。

int64

Identity Platform ID 權杖到期前的秒數。

string

已淘汰，目前不會傳回實際的密碼雜湊。

bool

帳戶的電子郵件是否已通過驗證。

string

這是必要旗標，開發人員斷言的自訂驗證權杖。憑證應為 JSON Web Token (JWT)，其中包含「自訂憑證宣告」部分中 API 參考資料所列的聲明。

string

bool

應一律為 true。

int64

string

使用者要登入的 Identity Platform 租用戶 ID。如果存在，這個 ID 應與符記中的 tenant_id 相符。

string

string

經過驗證的使用者所需的 Identity Platform ID 權杖。

string

已驗證使用者的 Identity Platform 重新整理權杖。

int64

ID 權杖到期前的秒數。

bool

系統是否已透過這項要求建立已驗證的使用者。

string

這是必要旗標，電子郵件連結中的額外程式碼。

string

這是必要旗標，系統傳送登入連結的電子郵件地址。電子郵件長度不得超過 256 個半形字元，格式為 [email protected]。電子郵件也應符合 RFC 822 的 addr-spec 產生方式。

string

Identity Platform 帳戶的有效 ID 權杖。如果通過，這項要求會將電子郵件地址連結至由此 ID 權杖代表的使用者，並在日後啟用帳戶的電子郵件連結登入功能。

string

使用者要登入的 Identity Platform 租用戶 ID。如果未設定，使用者會登入預設的 Identity Platform 專案。

string

string

經過驗證的使用者所需的 Identity Platform ID 權杖。

string

使用者用來登入的電子郵件地址。回應中一律會出現。

string

已驗證使用者的權杖重新整理。

int64

ID 權杖到期前的秒數。

string

已驗證使用者的 ID。回應中一律會出現。

bool

系統是否已透過此要求建立已驗證的使用者。

string

不透明字串，可做為使用者已成功通過第一個因素檢查的證明。

MfaEnrollment

已啟用的多重驗證服務供應商資訊。如果使用者需要使用多重驗證功能完成登入程序，就會顯示這項屬性。

string

這是必要旗標，使用者的 Game Center 玩家 ID。已由 Apple 淘汰。

將 playerID 與 gamePlayerID 和 teamPlayerID 一併傳遞，即可開始將使用者的 Game Center 玩家 ID 遷移至 gamePlayerID。

string

這是必要旗標，用來擷取 Apple 公開金鑰的網址，以便驗證由 Apple 簽署的簽名。

string

這是必要旗標，Apple 產生的驗證簽名資料。

string

這是必要旗標，用於產生指定簽章的隨機字串。

int64

這是必要旗標，Apple 建立簽章的時間，以 Epoch 紀元時間起算的毫秒數為單位。

string

Identity Platform 帳戶的有效 ID 權杖。如果有此 ID 符記，這項要求會將 Game Center 玩家 ID 連結至由此 ID 符記代表的帳戶。

string

使用者的 Game Center 顯示名稱。

string

使用者要登入的 Identity Platform 租用戶 ID。

string

使用者的 Game Center 團隊玩家 ID。您使用開發人員帳戶發行的所有遊戲玩家專屬 ID。https://developer.apple.com/documentation/gamekit/gkplayer/3174857-teamplayerid

string

使用者的 Game Center 遊戲玩家 ID。遊戲玩家的專屬 ID。https://developer.apple.com/documentation/gamekit/gkplayer/3113960-gameplayerid

string

已驗證使用者的 ID。回應中一律會出現。

string

使用者的 Game Center 玩家 ID。

將 playerID 與 gamePlayerID 和 teamPlayerID 一併傳遞，即可開始將使用者的 Game Center 玩家 ID 遷移至 gamePlayerID。

string

經過驗證的使用者所需的 Identity Platform ID 權杖。

string

已驗證使用者的 Identity Platform 重新整理權杖。

int64

ID 權杖到期前的秒數。

bool

這項要求是否建立登入使用者。

string

已驗證使用者的顯示名稱。

string

使用者的 Game Center 團隊玩家 ID。您使用開發人員帳戶發行的所有遊戲玩家專屬 ID。https://developer.apple.com/documentation/gamekit/gkplayer/3174857-teamplayerid

string

使用者的 Game Center 遊戲玩家 ID。遊戲玩家的專屬 ID。https://developer.apple.com/documentation/gamekit/gkplayer/3113960-gameplayerid

string

這是必要旗標，IdP 將使用者重新導向的網址。如果使用者是使用手動提供的 IdP 憑證登入，則可將這項屬性設為 http://localhost。

string

如果使用者是透過先前的 CreateAuthUri 授權要求取得授權回應，則這是 IdP 的 HTTP POST 回呼內容 (如有)。

否則，如果使用者是使用手動提供的 IdP 憑證登入，則這應為 URL 編碼表單，其中包含憑證 (例如 ID 權杖或 OAuth 2.0 IdP 的存取權杖)，以及核發憑證的 IdP 提供者 ID。

舉例來說，如果使用者使用 Google ID 權杖登入 Google 供應器，則應將此權杖設為 id_token=[GOOGLE_ID_TOKEN]&providerId=google.com，其中 [GOOGLE_ID_TOKEN] 應替換為 Google ID 權杖。

如果使用者是使用 Facebook 驗證權杖登入 Facebook 供應器，則應將此值設為 id_token=[FACEBOOK_AUTHENTICATION_TOKEN]&providerId=facebook. com&nonce= [NONCE]，其中 [FACEBOOK_AUTHENTICATION_TOKEN] 應替換為 Facebook 驗證權杖。驗證權杖時必須使用 Nonce。如果未提供 Nonce，要求就會失敗。

如果使用者使用 Facebook 存取權杖登入 Facebook 供應器，則應將此值設為 access_token=[FACEBOOK_ACCESS_TOKEN]&providerId=facebook. com，其中 [FACEBOOK_ACCESS_TOKEN] 應替換為 Facebook 存取權杖。

如果使用者使用 Twitter OAuth 1.0 憑證登入 Twitter 供應商，則應將此值設為 access_token=[TWITTER_ACCESS_TOKEN]&oauth_token_secret= [TWITTER_TOKEN_SECRET]&providerId=twitter.com，其中 [TWITTER_ACCESS_TOKEN] 和 [TWITTER_TOKEN_SECRET] 分別應替換為 Twitter OAuth 存取權杖和 Twitter OAuth 權杖密碼。

string

bool

是否要從 IdP 傳回 OAuth 更新權杖 (如有)。

string

先前 CreateAuthUri 呼叫傳回的工作階段 ID。系統會根據該工作階段 ID 驗證這個欄位，以防範工作階段固定攻擊。如果使用者是使用先前 CreateAuthUri 授權要求的授權回應登入，則必須提供此參數。

int64

string

有效的 Identity Platform ID 權杖。如果通過，IdP 中的使用者帳戶就會連結至此 ID 權杖所代表的帳戶。

bool

應一律為 true。

bool

是否要針對以下錯誤 FEDERATED_USER_ID_ALREADY_LINKED 和 EMAIL_EXISTS 從 IdP 傳回 OAuth 憑證。

bool

string

使用者要登入的 Identity Platform 租用戶 ID。如果未設定，使用者會登入預設的 Identity Platform 專案。

string

來自先前 SignInWithIdp 回應的不透明字串。如果已設定，則可用於重複執行先前 SignInWithIdp 作業的登入作業。如果使用者需要在先前的聯合登入嘗試中確認帳戶資訊，或執行帳戶連結作業，就可能會出現這個錯誤。

string

使用者在 IdP 中的帳戶 ID。回應中一律會出現。

string

使用者登入的 IdP 提供者 ID。回應中一律會出現。

string

使用者在 IdP 帳戶中的電子郵件地址。

bool

使用者帳戶的電子郵件地址是否已完成驗證。

string

使用者在 IdP 帳戶中的名字。

string

使用者在 IdP 帳戶中的全名。

string

使用者在 IdP 帳戶中的姓氏。

string

使用者在 ID 提供者帳戶中的暱稱。

string

使用者在 IdP 帳戶的語言偏好設定。

string

IdP 中使用者帳戶的時區。

string

IdP 中使用者個人資料相片的網址。

string

使用者在 ID 提供者帳戶中的出生日期。

string

string

使用者 Identity Platform 帳戶的主要 (頂層) 電子郵件地址，如果與 IdP 中的電子郵件地址不同。只有在啟用「每個電子郵件地址一個帳戶」設定時才會顯示。

string

已驗證的 Identity Platform 使用者 ID。回應中一律會出現。

bool

是否有現有的 Identity Platform 使用者帳戶，使用相同的電子郵件地址，但連結至同一 IdP 的其他帳戶。只有在啟用「每個電子郵件地址只能建立一個帳戶」設定，且 ID 提供者中的電子郵件地址已驗證過時，這個選項才會顯示。

string

IdP 中使用者帳戶的顯示名稱。

string

經過驗證的使用者所需的 Identity Platform ID 權杖。

string

CreateAuthUri 中設定的不透明字串，用於在驗證要求和 IdP 回呼之間維持情境資訊。

string

使用者可登入的提供者 ID 清單，以便解決 need_confirmation 錯誤。只有在 need_confirmation 設為 true 時才會出現。

bool

是否有現有的 Identity Platform 使用者帳戶，其電子郵件地址與目前在 IdP 登入的帳戶相同，且該帳戶的電子郵件地址未在 IdP 驗證。使用者必須登入現有的 Identity Platform 帳戶，然後將 IdP 目前的憑證連結至該帳戶。只有在啟用「每個電子郵件地址一個帳戶」設定時才會顯示。

string

來自 IdP 的 OAuth 存取權杖 (如有)。

string

來自 IdP 的 OAuth 2.0 更新權杖 (如果可用且 return_refresh_token 已設為 true)。

int32

IdP 的 OAuth 存取權杖到期前剩餘的秒數。

string

OAuth 2.0 授權碼 (如有)。僅適用於 Google 供應器。

bool

string

IdP 提供的 OAuth 1.0 憑證密鑰 (如有)。僅適用於 Twitter 供應器。

string

已驗證使用者的 Identity Platform 重新整理權杖。

int64

Identity Platform ID 權杖到期前的秒數。

string

來自 IdP 的 OpenID Connect ID 權杖 (如有)。

string

使用者在 Twitter IdP 帳戶的螢幕名稱，或使用者在 GitHub IdP 帳戶的登入名稱。

string

字串化 JSON 回應，其中包含與 IdP 使用者帳戶相對應的所有資料。

string

如果將 return_idp_credential 設為 true，且發生 FEDERATED_USER_ID_ALREADY_LINKED 或 EMAIL_EXISTS 錯誤，系統會傳回錯誤訊息。這個欄位的值為 FEDERATED_USER_ID_ALREADY_LINKED 或 EMAIL_EXISTS。

bool

是否為已驗證的使用者建立新的 Identity Platform 帳戶。

string

string

這個不透明字串可用於使用者登入的 IdP 憑證。您可以在這裡取得待處理的權杖，並在日後的 SignInWithIdp 要求中設定，以便再次透過 IdP 登入相同使用者。

string

要求中 tenant_id 欄位的值。

string

這項隱含的字串可做為證明使用者已成功通過第一層驗證的證明。

MfaEnrollment

帳戶啟用的多重驗證供應商資訊。如果使用者需要使用多重驗證功能完成登入程序，就會顯示這項屬性。

string

這是必要旗標，使用者用來登入的電子郵件地址。電子郵件長度不得超過 256 個半形字元，且格式為 [email protected]。電子郵件也應符合 RFC 822 的 addr-spec 產生方式。

string

這是必要旗標，使用者提供的密碼，用於登入帳戶。

string

string

string

reCAPTCHA 用戶端整合功能提供的 reCAPTCHA 權杖。reCAPTCHA Enterprise 會使用這項權杖進行風險評估。啟用 reCAPTCHA Enterprise 時必須提供。

string

int64

string

bool

應一律為 true。

string

使用者要登入的 Identity Platform 租用戶 ID。如果未設定，使用者會登入專案中的預設 Identity Platform 例項。

ClientType

用戶端類型 (網頁、Android 或 iOS)。啟用 reCAPTCHA Enterprise 時必須提供。

RecaptchaVersion

captcha_response 中 reCAPTCHA 權杖的 reCAPTCHA 版本。

string

string

已驗證使用者的 ID。回應中一律會出現。

string

已驗證使用者的電子郵件地址。回應中一律會出現。

string

儲存在帳戶屬性中的使用者顯示名稱。

string

經過驗證的使用者所需的 Identity Platform ID 權杖。

bool

電子郵件地址是否屬於現有帳戶。一律為 true。

string

儲存在帳戶屬性中的使用者個人資料相片。

string

OAuth2 存取權杖。

int32

存取權杖的過期時間 (以秒為單位)。

string

string

已驗證使用者的 Identity Platform 重新整理權杖。

int64

Identity Platform ID 權杖到期前的秒數。

string

這項隱含的字串可做為證明使用者已成功通過第一層驗證的證明。

MfaEnrollment

帳戶啟用的多重驗證供應商資訊。如果使用者需要使用多重驗證功能完成登入程序，就會顯示這項屬性。

UserNotification

使用者警告通知。

string

來自 [sendVerificationCode][v1.accounts.sendVerificationCode] 回應的加密工作階段資訊。如果是使用簡訊驗證碼，則必須指定此值，但如果是使用臨時證明，則可以不指定。

string

使用者用於登入的電話號碼。使用臨時證件的情況下，這項資訊是必要的，且必須與產生臨時證件的請求中驗證的電話號碼相符。如果傳遞工作階段資訊，系統會略過這個欄位。

string

使用者輸入的驗證碼，來自傳送至使用者手機的簡訊。

string

電話號碼驗證的證明，由先前的 [signInWithPhoneNumber][v1.accounts.signInWithPhoneNumber] 要求提供。如果傳遞此值，呼叫端也必須在 phone_number 欄位中傳遞先前要求中驗證過的電話號碼。

string

請勿使用。

string

Identity Platform 帳戶的有效 ID 權杖。如果通過，且電話號碼未使用，這項要求會將電話號碼連結至由此 ID 權杖代表的使用者；如果電話號碼已連結至使用者，則會重新驗證使用者。

VerifyOp

string

使用者要登入的 Identity Platform 租用戶 ID。如果未設定，使用者會登入預設的 Identity Platform 專案。

string

已驗證使用者的 Identity Platform ID 權杖。

string

已驗證使用者的權杖重新整理。

int64

ID 權杖到期前的秒數。

string

已驗證使用者的 ID。在驗證成功的情況下顯示。如果電話號碼可以驗證，但無法執行帳戶操作，系統會改為傳回臨時證明。

bool

系統是否已透過這項要求建立已驗證的使用者。

string

電話號碼驗證證明，如果電話驗證成功，但使用者操作失敗，則會提供這項證明。當要求嘗試使用 ID 權杖將電話號碼連結至使用者，或使用 ID 權杖重新驗證，但電話號碼已連結至其他使用者時，就會發生這種情況。

string

請勿使用。

int64

請勿使用。

string

已驗證使用者的電話號碼。回應中一律會出現。

int64

臨時證件到期前的秒數。

string

要指派給新建立使用者的電子郵件地址。電子郵件長度不得超過 256 個半形字元，且格式為 [email protected]。電子郵件也必須符合 RFC 822 的 addr-spec 產生方式。如未提供，系統會建立匿名使用者。

string

要指派給建立的使用者所使用的密碼。密碼長度至少須為 6 個半形字元。如果已設定，則必須一併設定 email 欄位。

string

要建立的使用者顯示名稱。

string

string

reCAPTCHA 用戶端整合功能提供的 reCAPTCHA 權杖。reCAPTCHA Enterprise 會使用這項權杖進行評估。啟用 reCAPTCHA Enterprise 時必須提供。

string

string

Identity Platform 使用者的有效 ID 權杖。如果設定了這個值，這項要求就會將驗證憑證連結至由此 ID 權杖代表的使用者。對於非管理員要求，必須同時設定 email 和 password 欄位。對於管理員要求，local_id 不得設定。

bool

使用者是否已驗證電子郵件地址。如要指定這個欄位，您必須具備具備適當權限的 Google OAuth 2.0 憑證。

string

要建立的使用者個人資料相片網址。

bool

系統是否會在建立使用者時將其停用。除了具備適當權限的 Google OAuth2 憑證要求外，您無法存取已停用的帳戶。

string

要建立的使用者 ID。這個 ID 在使用者所屬專案中不得重複。如要指定這個欄位，您必須具備具備適當權限的 Google OAuth 2.0 憑證。

string

要建立的使用者電話號碼。如要指定這個欄位，您必須具備具備適當權限的 Google OAuth 2.0 憑證。

string

要建立使用者的 Identity Platform 租戶 ID。如未設定，系統會在預設的 Identity Platform 專案下建立使用者。

string

使用者應屬於的專案 ID。如要指定這個欄位，您必須具備具備適當權限的 Google OAuth 2.0 憑證。如果未設定此屬性，系統會根據與 Bearer 存取權杖相關聯的範圍推斷目標專案。

MfaFactor

使用者要建立的多重驗證供應商。

ClientType

用戶端類型：網頁、Android 或 iOS。啟用 reCAPTCHA Enterprise 防護功能時必填。

RecaptchaVersion

captcha_response 中 reCAPTCHA 權杖的 reCAPTCHA 版本。

string

這個 MFA 選項的顯示名稱，例如「公司手機」。

string

用於接收 MFA 動態密碼的電話號碼。

string

string

已建立使用者的 Identity Platform ID 權杖。這個欄位只會針對非管理員要求設定。

string

建立的使用者顯示名稱。

string

已建立使用者的電子郵件地址。

string

已建立使用者的 Identity Platform 重新整理權杖。這個欄位只會針對非管理員要求設定。

int64

ID 權杖到期前的秒數。

string

已建立使用者的 ID。回應中一律會出現。

string

這是必要旗標，用於雜湊帳戶密碼的雜湊函式。必須是下列其中一個：* HMAC_SHA256 * HMAC_SHA1 * HMAC_MD5 * SCRYPT * PBKDF_SHA1 * MD5 * HMAC_SHA512 * SHA1 * BCRYPT * PBKDF2_SHA256 * SHA256 * SHA512 * STANDARD_SCRYPT * ARGON2

bytes

用於雜湊密碼的簽署者金鑰。下列雜湊函式需要此選項：* SCRYPT、* HMAC_MD5、* HMAC_SHA1、* HMAC_SHA256、* HMAC_SHA512

bytes

在鹽值和純文字密碼之間插入一或多個位元組。為提升安全性，此字元應為單一不可列印字元。

int32

用於雜湊運算的輪數。僅適用於下列雜湊函式：* MD5 * SHA1 * SHA256 * SHA512 * PBKDF_SHA1 * PBKDF2_SHA256 * SCRYPT

int32

雜湊運算的記憶體成本。只有在雜湊函式為 SCRYPT 時才需要。

UserInfo

要上傳的帳戶清單。local_id 是每位使用者必填的欄位，其他欄位則為選填。

int64

bool

如果為 True，服務會在上傳帳戶前執行以下檢查清單：* 重複的電子郵件 * 重複的聯合 ID * 聯合 ID 供應器驗證 如果上傳的帳戶清單中存在重複項目，系統就不會上傳整個清單。如果電子郵件或聯合 ID 與專案/租用戶中已有的使用者重複，系統就不會上傳該帳戶，但其他帳戶不會受到影響。如果為 false，系統會略過這些檢查。

string

帳戶所屬 Identity Platform 專案的專案 ID。

授權需要指定資源 targetProjectId 的下列 IAM 權限：

• firebaseauth.users.create

bool

是否要使用要求中的相符 local_id 覆寫身分識別平台中的現有帳戶。如果為 true，現有帳戶會遭到覆寫。如果為 false，系統會傳回錯誤。

int32

STANDARD_SCRYPT 雜湊函式要使用的 CPU 記憶體成本參數。這個參數與 block_size 和 cpu_mem_cost 一同協助調整產生密碼雜湊值所需的資源，並應隨著處理器速度和記憶體技術的進步而調整。

int32

STANDARD_SCRYPT 雜湊函式要使用的並行處理成本參數。這個參數與 block_size 和 cpu_mem_cost 一同協助調整產生密碼雜湊值所需的資源，並應隨著處理器速度和記憶體技術的進步而調整。

int32

STANDARD_SCRYPT 雜湊函式使用的區塊大小參數。這個參數與並行處理和 cpu_mem_cost 一同協助調整產生密碼雜湊值所需的資源，並應隨著處理器速度和記憶體技術的進步而調整。

int32

STANDARD_SCRYPT 雜湊函式所需的鍵長度。不得小於 1。

PasswordHashOrder

string

帳戶所屬的 Identity Platform 用戶群 ID。

Argon2Parameters

Argon2 雜湊演算法的參數。

string

ErrorInfo

無法上傳的帳戶詳細錯誤資訊。

string

不可變動。帳戶的專屬 ID。

string

帳戶的電子郵件地址。電子郵件長度不得超過 256 個半形字元，且格式為 [email protected]。電子郵件地址也應符合 RFC 822 的 addr-spec。

string

帳戶的顯示名稱。Identity Platform 不會使用這項帳戶屬性。這項資訊僅供參考。

string

僅供輸出。帳戶的語言偏好設定。Identity Platform 不會使用這項帳戶屬性。這項資訊僅供參考。

string

帳戶個人資料相片的網址。Identity Platform 不會使用這項帳戶屬性。這項資訊僅供參考。

string

僅供輸出。帳戶的時區偏好設定。Identity Platform 不會使用這項帳戶屬性。這項資訊僅供參考。

string

僅供輸出。帳戶設定的出生日期。Identity Platform 不會使用這項帳戶屬性。這項資訊僅供參考。

bytes

帳戶的雜湊密碼。只有具備 Google OAuth2 憑證且具有適當權限的要求才能存取。

bytes

帳戶的密碼加鹽值。只有具有適當權限的 Google OAuth2 憑證要求才能存取。

int32

帳戶密碼的版本。只有具有適當權限的 Google OAuth2 憑證要求才能存取。

bool

帳戶的電子郵件地址是否已通過驗證。

double

帳戶上次更新密碼的時間戳記，以 1970-01-01T00:00:00Z 為起點，以毫秒為單位。

ProviderUserInfo

各種身分識別提供者提供的使用者資訊。

int64

系統應將 ID 權杖視為有效的時間戳記最久的時間 (以 Epoch 紀元後的秒數為單位)。在此時間之前發出的所有 ID 權杖都會視為無效。

bool

帳戶是否已停用。除了具備適當權限的 Google OAuth2 憑證要求外，無法存取已停用的帳戶。

int64

上次登入這個帳戶的時間，以紀元起算的毫秒數。

int64

帳戶建立時間，以 Epoch 紀元時間為始 (單位為毫秒)。

string

僅供輸出。這個帳戶的 Twitter 螢幕名稱或 GitHub 登入名稱。

bool

僅供輸出。這個帳戶是否已使用 SignInWithCustomToken 驗證。

string

僅限輸入。用於更新帳戶密碼的純文字密碼。這個欄位只會用於做為要求中的輸入內容。Identity Platform 在管理密碼時會使用加密安全的雜湊演算法，絕不會以純文字儲存或傳輸使用者的密碼。

string

帳戶的電話號碼。

string

新增至帳戶所產生的任何 ID 權杖的自訂權杖。長度不得超過 1,000 個字元，且必須採用有效的 JSON 格式。

bool

僅供輸出。帳戶是否可以透過電子郵件連結進行驗證。

string

這個帳戶所屬租用戶的 ID。只有在這個帳戶屬於租用戶時才會設定。

MfaEnrollment

這個帳戶啟用的多重驗證供應商資訊。

string

與這個帳戶相關聯的第一個電子郵件地址。帳戶的初始電子郵件地址一旦設定就無法變更，且可用於透過 GetOobCode 中的 RECOVER_EMAIL 流程，在您遺失帳戶存取權時進行復原。應符合 RFC 822 的 addr-spec。

Timestamp

上次為這個帳戶鑄造 ID 權杖的時間戳記。

NotificationCode

警告通知列舉。可用於本地化。

string

警告通知字串。可用做備用值。

string

iOS 用戶端註冊 APNs (Apple 推播通知服務) 後取得的裝置權杖。

bool

應用程式權杖是否位於 iOS 沙箱中。如果為 false，表示應用程式權杖位於正式環境。

string

收到應用程式權杖驗證成功的通知。

int64

建議的秒數，用於客戶等待推播通知的時間。