REST Resource: projects.oauthIdpConfigs

Recurso: OAuthIdpConfig

Opções de configuração para autenticação com um IdP OAuth.

Representação JSON
{
  "name": string,
  "clientId": string,
  "issuer": string,
  "displayName": string,
  "enabled": boolean,
  "clientSecret": string,
  "responseType": {
    object (OAuthResponseType)
  }
}
Campos
name

string

O nome do recurso OAuthIdpConfig, por exemplo: "projects/my-awesome-project/oauthIdpConfigs/oauth-config-id". Ignorado durante solicitações de criação.

clientId

string

O ID do cliente de um cliente OAuth.

issuer

string

Para provedores de identidade do OIDC, o identificador do emissor.

displayName

string

O nome de exibição da configuração definido pelos desenvolvedores.

enabled

boolean

Verdadeiro se permite que o usuário faça login com o provedor.

clientSecret

string

A chave secreta do cliente OAuth, para ativar o fluxo de código do OIDC.

responseType

object (OAuthResponseType)

O tipo de resposta a ser solicitado no fluxo de autorização do OAuth. É possível definir idToken ou code como verdadeiro, mas não ambos. Ainda não é possível definir os dois tipos como verdadeiros simultaneamente ({code: true, idToken: true}).

OAuthResponseType

O tipo de resposta a ser solicitado no fluxo de autorização do OAuth. É possível definir idToken ou code como verdadeiro, mas não ambos. Ainda não é possível definir os dois tipos como verdadeiros simultaneamente ({code: true, idToken: true}).

Consulte https://openid.net/specs/openid-connect-core-1_0.html#Authentication para conferir um mapeamento do tipo de resposta para o fluxo OAuth 2.0.

Representação JSON
{
  "idToken": boolean,
  "code": boolean,
  "token": boolean
}
Campos
idToken

boolean

Se verdadeiro, o token de ID é retornado do endpoint de autorização do IdP.

code

boolean

Se for verdadeiro, o código de autorização será retornado do endpoint de autorização do IdP.

token
(deprecated)

boolean

Não use. O tipo de resposta token não é compatível no momento.

Métodos

create

Crie uma configuração de IdP Oidc para um projeto do Identity Toolkit.

delete

Exclua uma configuração de IdP Oidc para um projeto do Identity Toolkit.

get

Extraia uma configuração de IdP Oidc para um projeto do Identity Toolkit.

list

Lista todas as configurações de Idp Oidc para um projeto do Identity Toolkit.

patch

Atualize uma configuração de Oidc Idp para um projeto do Identity Toolkit.