Zum Hauptinhalt springen
Version: 0.2.0-beta.1

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[];
  scopes_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 Authorization Server Metadata wie in RFC 8414 definiert.

Typdeklaration​

authorization_endpoint​

authorization_endpoint: string;

URL des Authorization Servers für den Authorization Endpoint [RFC6749]. Dies ist ERFORDERLICH, es sei denn, es werden keine Grant Types unterstützt, die den Authorization Endpoint 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 Proof Key for Code Exchange (PKCE) [RFC7636] Code-Challenge-Methoden, die von diesem Authorization Server unterstützt werden.

grant_types_supported?​

optional grant_types_supported: string[];

JSON-Array mit einer Liste der OAuth 2.0 Grant Type-Werte, die dieser Authorization Server 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 Introspection Endpoints des Authorization Servers [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 Issuer-Identifier (Aussteller) des Authorization Servers, 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 [JWK] Dokuments des Authorization Servers. Das referenzierte Dokument enthält die Signaturschlüssel, die der Client verwendet, um Signaturen des Authorization Servers 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 Endpoints des Authorization Servers [RFC7591].

response_modes_supported?​

optional response_modes_supported: string[];

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

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

response_types_supported​

response_types_supported: string[];

JSON-Array mit einer Liste der OAuth 2.0 response_type-Werte, die dieser Authorization Server 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 Revocation Endpoints des Authorization Servers [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[];

scopes_supported?​

optional scopes_supported: string[];

JSON-Array mit einer Liste der OAuth 2.0 scope-Werte, die dieser Authorization Server unterstützt. [RFC8414]

service_documentation?​

optional service_documentation: string;

token_endpoint​

token_endpoint: string;

URL des Token Endpoints des Authorization Servers [RFC6749]. Dies ist ERFORDERLICH, es sei denn, nur der Implicit Grant Type wird unterstützt.

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 Endpoint wird verwendet, um Informationen über den authentifizierten Benutzer abzurufen.

Siehe​

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