OIDC ディスカバリー文書

OpenID Connect は、アプリを構成してユーザーを認証するために使用できる情報 (トークンや公開鍵など) を格納するディスカバリー・プロトコルをサポートします。

エンドポイントの呼び出し

.well-known エンドポイントを呼び出すことにより、ディスカバリー文書とそれに含まれている情報を取得できます。

このエンドポイントはどこにありますか?

このエンドポイントは以下の URL にあります。

https://<region>.appid.cloud.ibm.com/oauth/v4/<tenantID>/.well-known/openid-configuration

使用可能なリージョンについてはこちらを参照してください。

このエンドポイントを呼び出すにはどうすればよいですか?

エンドポイントを呼び出すには、有効なテナントIDが必要で、ディスカバリー・ドキュメントのURIをアプリケーション・コードにハードコードする必要があります。

以下のサンプル cURL 要求を参照してください。

curl -X GET "https://<region>.appid.cloud.ibm.com/oauth/v4/<tenantID>/.well-known/openid-configuration" -H "accept: application/json"

この呼び出しでは何が返されますか?

返される応答は、以下の例のようになります。

{
  "issuer": "https://us-south.appid.cloud.ibm.com/oauth/v4/39a37f57-a227-4bfe-a044-93b6e6060b61",
  "authorization_endpoint": "https://us-south.appid.cloud.ibm.com/oauth/v4/39a37f57-a227-4bfe-a044-93b6e6060b61/authorization",
  "token_endpoint": "https://us-south.appid.cloud.ibm.com/oauth/v4/39a37f57-a227-4bfe-a044-93b6e6060b61/token",
  "jwks_uri": "https://us-south.appid.cloud.ibm.com/oauth/v4/39a37f57-a227-4bfe-a044-93b6e6060b61/publickeys",
  "subject_types_supported": [
    "public"
  ],
  "id_token_signing_alg_values_supported": [
    "RS256"
  ],
  "userinfo_endpoint": "https://us-south.appid.cloud.ibm.com/oauth/v4/39a37f57-a227-4bfe-a044-93b6e6060b61/userinfo",
  "scopes_supported": [
    "openid"
  ],
  "response_types_supported": [
    "code"
  ],
  "claims_supported": [
    "iss",
    "aud",
    "exp",
    "tenant",
    "iat",
    "sub",
    "nonce",
    "amr",
    "oauth_client"
  ],
  "grant_types_supported": [
    "authorization_code",
    "password",
    "refresh_token",
    "client_credentials",
    "urn:ietf:params:oauth:grant-type:jwt-bearer"
  ],
  "profiles_endpoint": "https://us-south.appid.cloud.ibm.com",
  "management_endpoint": "https://us-south.appid.cloud.ibm.com/management/v4/39a37f57-a227-4bfe-a044-93b6e6060b61",
  "service_documentation": "https://cloud.ibm.com/docs/appid?topic=appid-getting-started"
}

コンポーネントの説明
コンポーネント	説明
`issuer`	OIDC プロバイダーの場所。
`authorization_endpoint`	App ID OAuth 2.0 許可エンドポイントの URL。
`token_endpoint`	App ID OAuth 2.0 トークン・エンドポイントの URL。
`jwks_uri`	App ID Web 鍵セット文書の URL。
`subject_types_supported`	App ID によってサポートされるサブジェクト ID タイプのリストを格納する JSON 配列。
`id_token_signing_alg_values_supported`	App ID サーバーによってサポートされる JWS 署名アルゴリズムのリストを格納する JSON 配列。
`userinfo_endpoint`	App ID `/userinfo` エンドポイントの URL。
`scopes_supported`	App ID によってサポートされる OAuth 2.0 スコープ値のリストを格納する JSON 配列。
`response_types_supported`	App ID によってサポートされる OAuth 2.0 response_type 値のリストを格納する JSON 配列。
`claims_supported`	クレーム名のリストを格納する JSON 配列。
`grant_types_supported`	対応する OAuth 2.0 グラント・タイプの値のリストを含む JSON 配列。
`profiles_endpoint`	App ID ユーザー・プロファイル・エンドポイントの URL。