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"
}

表 1. 元件的說明
元件	說明
`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`	JSON 陣列，包含 App ID 所支援的主旨 ID 類型清單。
`id_token_signing_alg_values_supported`	JSON 陣列，包含 App ID 伺服器所支援的 JWS 簽署演算法清單。
`userinfo_endpoint`	App ID `/userinfo` 端點的 URL。
`scopes_supported`	JSON 陣列，包含 App ID 所支援的 OAuth 2.0 範圍值清單。
`response_types_supported`	JSON 陣列，包含 App ID 所支援的 OAuth 2.0 response_type 值清單。
`claims_supported`	JSON 陣列，包含宣告名稱的清單。
`grant_types_supported`	JSON 陣列，包含 App ID 所支援的 OAuth 2.0 授權類型值清單。
`profiles_endpoint`	App ID 使用者設定檔端點的 URL。