Method: projects.tenants.accounts

註冊新的電子郵件和密碼使用者或匿名使用者，或將匿名使用者升級為電子郵件和密碼使用者。如果管理員要求具備適當權限的 Google OAuth 2.0 憑證，系統會建立新的匿名使用者、電子郵件和密碼使用者，或電話號碼使用者。

如要識別 Google Cloud 專案，請在要求中提供 API 金鑰。

HTTP 要求

POST https://identitytoolkit.googleapis.com/v1/projects/{targetProjectId}/tenants/{tenantId}/accounts

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
targetProjectId

string

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

string

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

要求主體

要求主體包含下列結構的資料：

JSON 表示法 
{
  "email": string,
  "password": string,
  "displayName": string,
  "captchaChallenge": string,
  "captchaResponse": string,
  "instanceId": string,
  "idToken": string,
  "emailVerified": boolean,
  "photoUrl": string,
  "disabled": boolean,
  "localId": string,
  "phoneNumber": string,
  "mfaInfo": [
    {
      object (MfaFactor)
    }
  ],
  "clientType": enum (ClientType),
  "recaptchaVersion": enum (RecaptchaVersion)
}
欄位
email

string

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

string

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

string

要建立的使用者顯示名稱。
captchaChallenge
(deprecated)

string
captchaResponse

string

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

string
idToken

string

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

boolean

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

string

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

boolean

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

string

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

string

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

object (MfaFactor)

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

enum (ClientType)

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

enum (RecaptchaVersion)

captchaResponse 中 reCAPTCHA 權杖的 reCAPTCHA 版本。

回應主體

如果成功，回應主體會包含 SignUpResponse 的執行個體。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/cloud-platform

詳情請參閱 Authentication Overview。