1. Docs
  2. API Reference
  3. OIDC discovery document

OIDC discovery document

GET/environments/{environmentId}/.well-known/openid-configuration

OIDC discovery document for an Environment (GET /environments/{environment_id}/.well-known/openid-configuration on the platform host, or GET /.well-known/openid-configuration on the Environment's active custom auth domain). Returns the unwrapped provider metadata: the Environment's issuer, the authorization, token, userinfo, JWKS, and revocation endpoints, and the supported capabilities — response_types_supported (code), grant_types_supported (authorization_code, refresh_token), id_token_signing_alg_values_supported (RS256), scopes_supported (openid, profile, email, org, permissions), and code_challenge_methods_supported (S256). Every Environment is its own issuer with its own signing keys; the platform host's root path is not one and answers 404.

Path Parameters

environmentIdstring Required

The Environment's id

Responses

application/json

  • issuerstring*
  • authorization_endpointstring*
  • token_endpointstring*
  • userinfo_endpointstring*
  • jwks_uristring*
  • revocation_endpointstring*
  • end_session_endpointstring*
  • backchannel_logout_supportedboolean*
  • backchannel_logout_session_supportedboolean*
  • response_types_supportedstring[]*
  • grant_types_supportedstring[]*
  • subject_types_supportedstring[]*
  • id_token_signing_alg_values_supportedstring[]*
  • scopes_supportedstring[]*
  • code_challenge_methods_supportedstring[]*
  • token_endpoint_auth_methods_supportedstring[]*
  • revocation_endpoint_auth_methods_supportedstring[]*

application/json

  • errorApiErrorBodyDto*

Returned object

OpenIdConfigurationResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/environments/value/.well-known/openid-configuration"
Response
{
  "issuer": "string",
  "authorization_endpoint": "string",
  "token_endpoint": "string",
  "userinfo_endpoint": "string",
  "jwks_uri": "string",
  "revocation_endpoint": "string",
  "end_session_endpoint": "string",
  "backchannel_logout_supported": false,
  "backchannel_logout_session_supported": false,
  "response_types_supported": [
    "string"
  ],
  "grant_types_supported": [
    "string"
  ],
  "subject_types_supported": [
    "string"
  ],
  "id_token_signing_alg_values_supported": [
    "string"
  ],
  "scopes_supported": [
    "string"
  ],
  "code_challenge_methods_supported": [
    "string"
  ],
  "token_endpoint_auth_methods_supported": [
    "string"
  ],
  "revocation_endpoint_auth_methods_supported": [
    "string"
  ]
}
 Related endpoints Was this page helpful?

Tell us how we can improve this guide.

Canopy