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，為核發者 ID。
displayName

string

開發人員設定的設定顯示名稱。
enabled

boolean

如果允許使用者透過提供者登入，則值為「是」。
clientSecret

string

OAuth 用戶端的用戶端密鑰，用於啟用 OIDC 程式碼流程。
responseType

object (OAuthResponseType)

在 OAuth 授權流程中要求的回應類型。您可以將 idToken 或 code 設為 true，但不能兩者同時設為 true。系統尚未支援同時將兩種類型設為 true ({code: true, idToken: true})。

OAuthResponseType

在 OAuth 授權流程中要求的回應類型。您可以將 idToken 或 code 設為 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，系統會從 IdP 的授權端點傳回 ID 權杖。
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 設定。