Zum Hauptinhalt springen

Typalias: 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;
};

Schema für OAuth 2.0 Autorisierungsserver-Metadaten wie in RFC 8414 definiert.

Typdeklaration

authorization_endpoint

authorization_endpoint: string;

URL des Autorisierungsendpunkts des Autorisierungsservers [RFC6749]. Dies ist ERFORDERLICH, sofern keine Grant-Typen unterstützt werden, die den Autorisierungsendpunkt verwenden.

Siehe

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

code_challenge_methods_supported?

optional code_challenge_methods_supported: string[];

JSON-Array mit einer Liste der von diesem Autorisierungsserver unterstützten Proof Key for Code Exchange (PKCE) [RFC7636] Code-Challenge-Methoden.

grant_types_supported?

optional grant_types_supported: string[];

JSON-Array mit einer Liste der OAuth 2.0 Grant-Typ-Werte, die dieser Autorisierungsserver unterstützt. Die Array-Werte entsprechen denen, die mit dem grant_types-Parameter verwendet werden, wie im "OAuth 2.0 Dynamic Client Registration Protocol" [RFC7591] definiert. Wenn weggelassen, ist der Standardwert ["authorization_code", "implicit"].

introspection_endpoint?

optional introspection_endpoint: string;

URL des OAuth 2.0 Introspektionsendpunkts des Autorisierungsservers [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;

Der Aussteller (Issuer) des Autorisierungsservers, eine URL, die das https-Schema verwendet und keine Query- oder Fragment-Komponenten enthält.

jwks_uri?

optional jwks_uri: string;

URL des JWK-Set-Dokuments [JWK] des Autorisierungsservers. Das referenzierte Dokument enthält die Signierschlüssel, die der Client verwendet, um Signaturen des Autorisierungsservers zu validieren. Diese URL MUSS das https-Schema verwenden.

op_policy_uri?

optional op_policy_uri: string;

op_tos_uri?

optional op_tos_uri: string;

registration_endpoint?

optional registration_endpoint: string;

URL des OAuth 2.0 Dynamic Client Registration Endpunkts des Autorisierungsservers [RFC7591].

response_modes_supported?

optional response_modes_supported: string[];

JSON-Array mit einer Liste der OAuth 2.0 response_mode-Werte, die dieser Autorisierungsserver unterstützt, wie in "OAuth 2.0 Multiple Response Type Encoding Practices" [OAuth.Responses] spezifiziert.

Wenn weggelassen, ist der Standardwert ["query", "fragment"]. Der Response-Mode-Wert "form_post" ist ebenfalls in "OAuth 2.0 Form Post Response Mode" [OAuth.FormPost] definiert.

response_types_supported

response_types_supported: string[];

JSON-Array mit einer Liste der OAuth 2.0 response_type-Werte, die dieser Autorisierungsserver unterstützt. Die Array-Werte entsprechen denen, die mit dem response_types-Parameter verwendet werden, wie im "OAuth 2.0 Dynamic Client Registration Protocol" [RFC7591] definiert.

revocation_endpoint?

optional revocation_endpoint: string;

URL des OAuth 2.0 Widerrufsendpunkts des Autorisierungsservers [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 des Token-Endpunkts des Autorisierungsservers [RFC6749]. Dies ist ERFORDERLICH, sofern nur der Implicit Grant-Typ unterstützt wird.

Siehe

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 des OpenID Connect userinfo endpoint. Dieser Endpunkt wird verwendet, um Informationen über den authentifizierten Benutzer abzurufen.

Siehe

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