获取项目的公开 Identity Toolkit 配置。(旧版)此方法还支持开发者进行身份验证调用以检索非公开配置。
HTTP 请求
GET https://identitytoolkit.googleapis.com/v1/projects
网址采用 gRPC 转码语法。
查询参数
参数 | |
---|---|
delegatedProjectNumber |
委托项目请求的项目编号。此字段应仅在 Firebase V1 迁移过程中使用。 |
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[] |
用于 widget 重定向的已获授权网域。 |
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 |
如果允许用户使用提供方进行登录,则为 true。 |
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 格式。 |