REST Resource: projects.oauthIdpConfigs

资源:OAuthIdpConfig

用于使用 OAuth IDP 进行身份验证的配置选项。

JSON 表示法
{
  "name": string,
  "clientId": string,
  "issuer": string,
  "displayName": string,
  "enabled": boolean,
  "clientSecret": string,
  "responseType": {
    object (OAuthResponseType)
  }
}
字段
name

string

OAuthIdpConfig 资源的名称,例如:'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'。在创建请求期间会被忽略。

clientId

string

OAuth 客户端的客户端 ID。

issuer

string

对于 OIDC Idp,是颁发者标识符。

displayName

string

开发者设置的配置显示名称。

enabled

boolean

如果允许用户使用提供方进行登录,则为 true。

clientSecret

string

OAuth 客户端的客户端密钥,用于启用 OIDC 代码流程。

responseType

object (OAuthResponseType)

要在 OAuth 授权流程中请求的响应类型。您可以将 idTokencode 设置为 true,但不能同时将这两者设置为 true。尚不支持将这两种类型同时设置为 true ({code: true, idToken: true})。

OAuthResponseType

要在 OAuth 授权流程中请求的响应类型。您可以将 idTokencode 设置为 true,但不能同时将这两者设置为 true。尚不支持将这两种类型同时设置为 true ({code: true, idToken: true})。

如需了解响应类型与 OAuth 2.0 流程的映射,请参阅 https://openid.net/specs/openid-connect-core-1_0.html#Authentication

JSON 表示法
{
  "idToken": boolean,
  "code": boolean,
  "token": boolean
}
字段
idToken

boolean

如果为 true,则 ID 令牌会从 IdP 的授权端点返回。

code

boolean

如果为 true,则授权代码会从 IdP 的授权端点返回。

token
(deprecated)

boolean

请勿使用。目前不支持 token 响应类型。

方法

create

为 Identity Toolkit 项目创建 Oidc Idp 配置。

delete

删除 Identity Toolkit 项目的 OIDC Idp 配置。

get

检索 Identity Toolkit 项目的 Oidc Idp 配置。

list

列出 Identity Toolkit 项目的所有 OIDC Idp 配置。

patch

更新 Identity Toolkit 项目的 OIDC Idp 配置。