oauth2.dev

service_documentation

IESG

Registry Context

Optional metadata telling clients where to find human-readable documentation about using the authorization server.

Technical Summary

The `service_documentation` authorization server metadata member is an OPTIONAL URL for a page containing human-readable information that developers might want or need when using the authorization server.

When Used

Used when an authorization server publishes developer-facing documentation, including client registration instructions when Dynamic Client Registration is not supported.

Normative Requirements

Authorization servers

OPTIONAL
1
  1. RFC 8414 - Section 2

    Include the `service_documentation` metadata member as a URL of a page containing human-readable information for developers using the authorization server..

    service_documentation OPTIONAL. URL of a page containing human-readable information that developers might want or need to know when using the authorization server.

Validation Guidance

info

Do not reject an authorization server metadata document because `service_documentation` is omitted.

warning

If present, verify that `service_documentation` is a URL identifying a page containing human-readable information for developers using the authorization server.

Reference

Details

Entry Id
service_documentation
Metadata Name
service_documentation
Metadata Description
URL of a page containing human-readable information that developers might want or need to know when using the authorization server
Change Controller
IESG
Reference
RFC8414 - Section 2