Method: projects.accounts.batchCreate

將多個帳戶上傳至 Google Cloud 專案。如果上傳一或多個帳戶時發生問題,系統會上傳其餘帳戶,並傳回錯誤清單。使用這個方法需要具備 Google OAuth 2.0 憑證,且具備適當的權限

HTTP 要求

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

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

路徑參數

參數
targetProjectId

string

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

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

  • firebaseauth.users.create

要求主體

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

JSON 表示法
{
  "hashAlgorithm": string,
  "signerKey": string,
  "saltSeparator": string,
  "rounds": integer,
  "memoryCost": integer,
  "users": [
    {
      object (UserInfo)
    }
  ],
  "delegatedProjectNumber": string,
  "sanityCheck": boolean,
  "allowOverwrite": boolean,
  "cpuMemCost": integer,
  "parallelization": integer,
  "blockSize": integer,
  "dkLen": integer,
  "passwordHashOrder": enum (PasswordHashOrder),
  "tenantId": string,
  "argon2Parameters": {
    object (Argon2Parameters)
  }
}
欄位
hashAlgorithm

string

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

signerKey

string (bytes format)

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

Base64 編碼字串。

saltSeparator

string (bytes format)

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

Base64 編碼字串。

rounds

integer

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

memoryCost

integer

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

users[]

object (UserInfo)

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

delegatedProjectNumber
(deprecated)

string (int64 format)

sanityCheck

boolean

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

allowOverwrite

boolean

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

cpuMemCost

integer

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

parallelization

integer

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

blockSize

integer

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

dkLen

integer

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

passwordHashOrder

enum (PasswordHashOrder)

tenantId

string

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

argon2Parameters

object (Argon2Parameters)

Argon2 雜湊演算法的參數。

回應主體

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

授權範圍

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

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

詳情請參閱 Authentication Overview