OIDCAuthProviderConfig interface

A interface de configuração do provedor do Auth [OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html). É possível criar um provedor OIDC por meio de BaseAuth.createProviderConfig().

Assinatura:

export interface OIDCAuthProviderConfig extends BaseAuthProviderConfig

Estende: BaseAuthProviderConfig

Propriedades

Propriedade Tipo Descrição
clientId. string É o ID do cliente obrigatório usado para confirmar o público do [token de ID](https://openid.net/specs/openid-connect-core-1_0-final.html#IDToken) de um provedor OIDC.
clientSecret (em inglês) string A chave secreta do cliente do provedor do OIDC para ativar o fluxo de código do OIDC.
emissor string Este é o emissor obrigatório do provedor usado para corresponder ao emissor do provedor do token de ID e para determinar o documento de descoberta do OIDC correspondente, por exemplo, [/.well-known/openid-configuration](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig). Isso é necessário para o seguinte:
  • Para verificar o emissor fornecido.
  • Determinar o endpoint de autenticação/autorização durante o fluxo de autenticação id_token do OAuth.
  • Para recuperar as chaves de assinatura públicas via jwks_uri e verificar a assinatura do token de ID do provedor OIDC.
  • Para determinar o claim_supported para construir os atributos do usuário a serem retornados na resposta de informações adicionais do usuário.
A validação do token de ID será realizada conforme definido na [especificação](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).
responseType (em inglês) OAuthResponseType (em inglês). O objeto de resposta do provedor OIDC para o fluxo de autorização do OAuth.

OIDCAuthProviderConfig.clientId

É o ID do cliente obrigatório usado para confirmar o público do [token de ID](https://openid.net/specs/openid-connect-core-1_0-final.html#IDToken) de um provedor OIDC.

Assinatura:

clientId: string;

OIDCAuthProviderConfig.clientSecret

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

Assinatura:

clientSecret?: string;

OIDCAuthProviderConfig.issuer

Este é o emissor obrigatório do provedor usado para corresponder ao emissor do provedor do token de ID e para determinar o documento de descoberta do OIDC correspondente, por exemplo, [/.well-known/openid-configuration](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig). Isso é necessário para:

  • Para verificar o emissor fornecido.
  • Determinar o endpoint de autenticação/autorização durante o fluxo de autenticação id_token do OAuth.
  • Para recuperar as chaves de assinatura públicas via jwks_uri e verificar a assinatura do token de ID do provedor OIDC.
  • Para determinar o claim_supported para construir os atributos do usuário a serem retornados na resposta de informações adicionais do usuário.
A validação do token de ID será realizada conforme definido na [especificação](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).

Assinatura:

issuer: string;

OIDCAuthProviderConfig.responseType

O objeto de resposta do provedor OIDC para o fluxo de autorização do OAuth.

Assinatura:

responseType?: OAuthResponseType;