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

ユーザーがプロバイダでログインできるようにする場合は true。

clientSecret

string

OIDC コードフローを有効にするための OAuth クライアントのクライアント シークレット。

responseType

object (OAuthResponseType)

OAuth 認証フロー内でリクエストするレスポンス タイプ。idToken または code のいずれかを true に設定できますが、両方は設定できません。両方のタイプを同時に true({code: true, idToken: true})に設定することはまだサポートされていません。

OAuthResponseType

OAuth 認証フロー内でリクエストするレスポンス タイプ。idToken または code のいずれかを 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 構成を更新します。