取得專案的公開 Identity Toolkit 設定。(已淘汰) 這個方法也支援開發人員透過驗證的呼叫,擷取非公開設定。
HTTP 要求
GET https://identitytoolkit.googleapis.com/v1/projects
這個網址使用 gRPC 轉碼語法。
查詢參數
參數 | |
---|---|
delegatedProjectNumber |
委派專案要求的專案編號。這個欄位僅應用於 Firebase 1.0 遷移作業。 |
projectNumber |
要擷取的設定專案編號。這個欄位已淘汰,新整合項目不應使用。 |
returnDynamicLink |
是否應傳回動態連結。 |
androidPackageName |
要與實際 Android 套件名稱進行比對的 Android 套件名稱。如果您提供這個欄位,但未提供 sha1_cert_hash,且這個欄位不符合實際的 Android 套件名稱,則動作會擲回錯誤。 |
iosBundleId |
iOS 軟體包 ID,用於比對實際的 iOS 軟體包 ID。如果提供這個欄位,如果這個欄位不符合實際的 iOS 套件 ID,這個動作就會擲回錯誤。 |
clientId |
RP OAuth 用戶端 ID。如果已設定,系統會執行檢查,確保 OAuth 用戶端適用於擷取的專案,如果不符合要求,則會拒絕要求並顯示用戶端錯誤。 |
sha1Cert |
SHA-1 Android 應用程式憑證雜湊。如果已設定,系統會執行檢查,確保憑證雜湊值適用於擷取的專案和 androidPackageName。 |
firebaseAppId |
Firebase 應用程式 ID (適用於使用 Firebase 的應用程式)。您可以在專案的 Firebase 控制台中找到這項資訊。如果已設定,系統會執行檢查,確保應用程式 ID 適用於擷取的專案。如果無效,系統會拒絕要求,並傳回用戶端錯誤。 |
要求主體
要求主體必須為空白。
回應主體
v1.getProjects 的回應訊息。
如果成功,回應主體會含有以下結構的資料:
JSON 表示法 |
---|
{ "projectId": string, "apiKey": string, "allowPasswordUser": boolean, "idpConfig": [ { object ( |
欄位 | |
---|---|
projectId |
擷取的設定專案 ID。 |
apiKey |
Google Cloud API 金鑰這個欄位只會傳回開發人員的已驗證呼叫。 |
allowPasswordUser |
是否允許使用密碼帳戶註冊。這個欄位只會傳回開發人員的已驗證呼叫。 |
idpConfig[] |
OAuth2 提供者設定。這個欄位只會傳回開發人員的已驗證呼叫。 |
authorizedDomains[] |
小工具重新導向的授權網域。 |
enableAnonymousUser |
是否啟用匿名使用者。這個欄位只會傳回開發人員的已驗證呼叫。 |
dynamicLinksDomain |
Firebase Dynamic Links 網域,用於建立連結,將使用者重新導向至原生應用程式。 |
useEmailSending |
是否使用電子郵件傳送。這個欄位只會傳回開發人員的已驗證呼叫。 |
resetPasswordTemplate |
密碼重設電子郵件範本。這個欄位只會傳回開發人員的已驗證呼叫。 |
verifyEmailTemplate |
驗證電子郵件的電子郵件範本。這個欄位只會傳回開發人員的已驗證呼叫。 |
changeEmailTemplate |
變更電子郵件的電子郵件範本。這個欄位只會傳回開發人員的已驗證呼叫。 |
legacyResetPasswordTemplate |
舊版 Firebase V1 應用程式的密碼重設電子郵件範本。這個欄位只會針對開發人員的已驗證呼叫傳回。 |
revertSecondFactorAdditionTemplate |
用於撤銷新增第二個驗證方法的電子郵件範本。這個欄位只會傳回開發人員的已驗證呼叫。 |
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/identitytoolkit
https://www.googleapis.com/auth/cloud-platform
詳情請參閱 Authentication Overview。
IdpConfig
識別資訊提供者的設定。
JSON 表示法 |
---|
{
"provider": enum ( |
欄位 | |
---|---|
provider |
|
enabled |
如果允許使用者透過提供者登入,則值為「是」。 |
experimentPercent |
系統會提示/重新導向使用者聯合登入此 IdP 的百分比 |
clientId |
OAuth2 用戶端 ID。 |
secret |
OAuth2 用戶端密鑰。 |
whitelistedAudiences[] |
用戶端 ID 已加入許可清單,可進行目標對象檢查。 |
供應商
識別資訊提供者的名稱。
列舉 | |
---|---|
PROVIDER_UNSPECIFIED |
|
MSLIVE |
Microsoft Live 做為識別資訊提供者。 |
GOOGLE |
Google 做為識別資訊提供者。 |
FACEBOOK |
Facebook 做為識別資訊提供者。 |
PAYPAL |
PayPal 做為識別資訊提供者。 |
TWITTER |
Twitter 做為識別資訊提供者。 |
YAHOO |
Yahoo 做為識別資訊提供者。 |
AOL |
AOL 做為識別資訊提供者。 |
GITHUB |
GitHub 做為識別資訊提供者。 |
GOOGLE_PLAY_GAMES |
Google Play 遊戲做為識別資訊提供者。 |
LINKEDIN |
LinkedIn 做為識別資訊提供者。 |
IOS_GAME_CENTER |
iOS Game Center 做為識別資訊提供者。 |
EmailTemplate
電子郵件範本
JSON 表示法 |
---|
{
"disabled": boolean,
"from": string,
"body": string,
"subject": string,
"fromDisplayName": string,
"format": enum ( |
欄位 | |
---|---|
disabled |
是否停用範本。如果為 true,系統會使用預設範本。 |
from |
電子郵件寄件地址 |
body |
電子郵件內文 |
subject |
電子郵件主旨 |
fromDisplayName |
起點顯示名稱 |
format |
電子郵件內文格式 |
replyTo |
回覆地址 |
fromLocalPart |
寄件者地址的本機部分 |
locale |
值採用 III 語言代碼格式 (例如「zh-CN」、「es」)。系統接受「-」和「_」分隔符。 |
customized |
電子郵件內文或主旨是否為自訂內容。 |
EmailBodyFormat
電子郵件內文格式
列舉 | |
---|---|
EMAIL_BODY_FORMAT_UNSPECIFIED |
預設值。請勿使用。 |
PLAINTEXT |
電子郵件內文採用純文字格式。 |
HTML |
電子郵件內文採用 HTML 格式。 |