メインコンテンツにスキップ

型エイリアス: 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;
};

RFC 8414 で定義されている OAuth 2.0 認可サーバーメタデータのスキーマです。

型宣言

authorization_endpoint

authorization_endpoint: string;

認可サーバーの認可エンドポイントの URL [RFC6749]。 認可エンドポイントを使用する grant type がサポートされていない場合を除き、これは必須です。

参照

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

code_challenge_methods_supported?

optional code_challenge_methods_supported: string[];

この認可サーバーがサポートする Proof Key for Code Exchange (PKCE) [RFC7636] の code challenge メソッドのリストを含む JSON 配列。

grant_types_supported?

optional grant_types_supported: string[];

この認可サーバーがサポートする OAuth 2.0 grant type 値のリストを含む JSON 配列。 配列の値は "OAuth 2.0 Dynamic Client Registration Protocol" [RFC7591] で定義された grant_types パラメーターで使用されるものと同じです。 省略された場合、デフォルト値は ["authorization_code", "implicit"] です。

introspection_endpoint?

optional introspection_endpoint: string;

認可サーバーの OAuth 2.0 インスペクションエンドポイントの URL [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;

認可サーバーの発行者 (Issuer) 識別子であり、https スキームを使用し、クエリやフラグメントコンポーネントを持たない URL です。

jwks_uri?

optional jwks_uri: string;

認可サーバーの JWK Set [JWK] ドキュメントの URL。参照されるドキュメントには、クライアントが認可サーバーからの署名を検証するために使用する署名鍵が含まれます。この URL は https スキームを使用しなければなりません。

op_policy_uri?

optional op_policy_uri: string;

op_tos_uri?

optional op_tos_uri: string;

registration_endpoint?

optional registration_endpoint: string;

認可サーバーの OAuth 2.0 Dynamic Client Registration エンドポイントの URL [RFC7591]。

response_modes_supported?

optional response_modes_supported: string[];

この認可サーバーがサポートする OAuth 2.0 response_mode 値のリストを含む JSON 配列。 "OAuth 2.0 Multiple Response Type Encoding Practices" [OAuth.Responses] で規定されています。

省略された場合、デフォルトは ["query", "fragment"] です。レスポンスモード値 "form_post" も "OAuth 2.0 Form Post Response Mode" [OAuth.FormPost] で定義されています。

response_types_supported

response_types_supported: string[];

この認可サーバーがサポートする OAuth 2.0 response_type 値のリストを含む JSON 配列。 配列の値は "OAuth 2.0 Dynamic Client Registration Protocol" [RFC7591] で定義された response_types パラメーターで使用されるものと同じです。

revocation_endpoint?

optional revocation_endpoint: string;

認可サーバーの OAuth 2.0 取り消しエンドポイントの URL [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 [RFC6749]。 暗黙的な grant type のみがサポートされている場合を除き、これは必須です。

参照

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;

OpenID Connect の userinfo エンドポイント の URL。 このエンドポイントは認証済みユーザーに関する情報を取得するために使用されます。

参照

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