Pular para o conteúdo principal

Alias de Tipo: AuthorizationServerMetadata

type AuthorizationServerMetadata = {
  authorization_endpoint: string;
  code_challenge_methods_supported?: string[];
  grant_types_supported?: string[];
  introspection_endpoint?: string;
  introspection_endpoint_auth_methods_supported?: string[];
  introspection_endpoint_auth_signing_alg_values_supported?: string[];
  issuer: string;
  jwks_uri?: string;
  op_policy_uri?: string;
  op_tos_uri?: string;
  registration_endpoint?: string;
  response_modes_supported?: string[];
  response_types_supported: string[];
  revocation_endpoint?: string;
  revocation_endpoint_auth_methods_supported?: string[];
  revocation_endpoint_auth_signing_alg_values_supported?: string[];
  scope_supported?: string[];
  service_documentation?: string;
  token_endpoint: string;
  token_endpoint_auth_methods_supported?: string[];
  token_endpoint_auth_signing_alg_values_supported?: string[];
  ui_locales_supported?: string[];
  userinfo_endpoint?: string;
};

Esquema para os metadados do Servidor de Autorização OAuth 2.0 conforme definido na RFC 8414.

Declaração do tipo

authorization_endpoint

authorization_endpoint: string;

URL do endpoint de autorização do servidor de autorização [RFC6749]. Isto é OBRIGATÓRIO, a menos que nenhum tipo de concessão seja suportado que utilize o endpoint de autorização.

Veja

https://rfc-editor.org/rfc/rfc6749#section-3.1

code_challenge_methods_supported?

optional code_challenge_methods_supported: string[];

Array JSON contendo uma lista de métodos de desafio de código Proof Key for Code Exchange (PKCE) [RFC7636] suportados por este servidor de autorização.

grant_types_supported?

optional grant_types_supported: string[];

Array JSON contendo uma lista dos valores de tipo de concessão OAuth 2.0 que este servidor de autorização suporta. Os valores do array usados são os mesmos usados com o parâmetro grant_types definido pelo "OAuth 2.0 Dynamic Client Registration Protocol" [RFC7591]. Se omitido, o valor padrão é ["authorization_code", "implicit"].

introspection_endpoint?

optional introspection_endpoint: string;

URL do endpoint de introspecção OAuth 2.0 do servidor de autorização [RFC7662].

introspection_endpoint_auth_methods_supported?

optional introspection_endpoint_auth_methods_supported: string[];

introspection_endpoint_auth_signing_alg_values_supported?

optional introspection_endpoint_auth_signing_alg_values_supported: string[];

issuer

issuer: string;

O identificador do emissor (Issuer) do servidor de autorização, que é uma URL que utiliza o esquema https e não possui componentes de consulta ou fragmento.

jwks_uri?

optional jwks_uri: string;

URL do documento JWK Set [JWK] do servidor de autorização. O documento referenciado contém a(s) chave(s) de assinatura que o cliente usa para validar assinaturas do servidor de autorização. Esta URL DEVE usar o esquema https.

op_policy_uri?

optional op_policy_uri: string;

op_tos_uri?

optional op_tos_uri: string;

registration_endpoint?

optional registration_endpoint: string;

URL do endpoint de Registro Dinâmico de Cliente OAuth 2.0 do servidor de autorização [RFC7591].

response_modes_supported?

optional response_modes_supported: string[];

Array JSON contendo uma lista dos valores de response_mode do OAuth 2.0 que este servidor de autorização suporta, conforme especificado em "OAuth 2.0 Multiple Response Type Encoding Practices" [OAuth.Responses].

Se omitido, o padrão é ["query", "fragment"]. O valor de response mode "form_post" também é definido em "OAuth 2.0 Form Post Response Mode" [OAuth.FormPost].

response_types_supported

response_types_supported: string[];

Array JSON contendo uma lista dos valores de response_type do OAuth 2.0 que este servidor de autorização suporta. Os valores do array usados são os mesmos usados com o parâmetro response_types definido pelo "OAuth 2.0 Dynamic Client Registration Protocol" [RFC7591].

revocation_endpoint?

optional revocation_endpoint: string;

URL do endpoint de revogação OAuth 2.0 do servidor de autorização [RFC7009].

revocation_endpoint_auth_methods_supported?

optional revocation_endpoint_auth_methods_supported: string[];

revocation_endpoint_auth_signing_alg_values_supported?

optional revocation_endpoint_auth_signing_alg_values_supported: string[];

scope_supported?

optional scope_supported: string[];

service_documentation?

optional service_documentation: string;

token_endpoint

token_endpoint: string;

URL do endpoint de token do servidor de autorização [RFC6749]. Isto é OBRIGATÓRIO, a menos que apenas o tipo de concessão implícita seja suportado.

Veja

https://rfc-editor.org/rfc/rfc6749#section-3.2

token_endpoint_auth_methods_supported?

optional token_endpoint_auth_methods_supported: string[];

token_endpoint_auth_signing_alg_values_supported?

optional token_endpoint_auth_signing_alg_values_supported: string[];

ui_locales_supported?

optional ui_locales_supported: string[];

userinfo_endpoint?

optional userinfo_endpoint: string;

URL do endpoint userinfo do OpenID Connect. Este endpoint é usado para recuperar informações sobre o usuário autenticado.

Veja

https://datatracker.ietf.org/doc/html/rfc8414