OAuth

Authorization server metadata (RFC 8414)

Changed on

Describes the authorization server: the authorization page on the main site, the token and registration endpoints of this API, the code response type, the authorization_code grant, PKCE S256, public clients only (token_endpoint_auth_methods_supported: ["none"]) and support for client ID metadata documents, so a client that publishes its metadata at an HTTPS URL can use that URL as client_id without registering.

get/.well-known/oauth-authorization-server

Request

  • Base URL: https://api.educaplay.com
  • URL: https://api.educaplay.com/.well-known/oauth-authorization-server
  • Auth: none required

Response

Metadata document.

issuerstring uri
authorization_endpointstring uri

Authorization page on the main site (/oauth/authorize/), where the user signs in and grants access.

token_endpointstring uri
registration_endpointstring uri
response_types_supportedstring[]
grant_types_supportedstring[]
code_challenge_methods_supportedstring[]
token_endpoint_auth_methods_supportedstring[]
client_id_metadata_document_supportedboolean
scopes_supportedstring[]

Example response

{
  "response_types_supported": [
    "code"
  ],
  "grant_types_supported": [
    "authorization_code"
  ],
  "code_challenge_methods_supported": [
    "S256"
  ],
  "token_endpoint_auth_methods_supported": [
    "none"
  ],
  "client_id_metadata_document_supported": true,
  "scopes_supported": [
    "educaplay"
  ]
}

Changes