claims_
Registry Context
claims_supported is an OpenID Provider metadata member that lists claim names the provider may be able to supply. It can also appear as an additional claim in an OAuth authorization server metadata response.
Technical Summary
The value is a JSON array of claim-name strings and might not be exhaustive. RFC 8414 permits claims beyond its defined metadata set. Claims returning multiple values are JSON arrays, and zero-element claims must be omitted.
When Used
Used in OpenID Provider metadata, or additionally in OAuth authorization server metadata, to advertise claim names that the provider may be able to supply.
Normative Requirements
Authorization servers
RFC 8414 - Section 3.2
use the 200 OK HTTP status code for a successful authorization server metadata response.
A successful response MUST use the 200 OK HTTP status code
RFC 8414 - Section 3.2
return a successful metadata response as a JSON object using the application/json content type.
A successful response MUST ... return a JSON object using the "application/json" content type
RFC 8414 - Section 3.2
omit claims_supported from the metadata response.
Condition: its array would contain zero elements
Claims with zero elements MUST be omitted from the response.
RFC 8414 - Section 3.2
return claims beyond the metadata values defined by RFC 8414.
Condition: in an authorization server metadata response
Other claims MAY also be returned.
Validation Guidance
If claims_supported is present, verify that its value is a JSON array of claim-name strings.
Accept claims_supported as an additional authorization server metadata claim not defined by RFC 8414 itself.
Report an empty claims_supported array as an error because a zero-element claim must be omitted.
For a successful authorization server metadata response, verify the 200 OK status code and application/json JSON-object response format.
Reference
Details
- Entry Id
claims_supported - Metadata Name
claims_supported - Metadata Description
JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for- Change Controller
OpenID_Foundation_ Artifact_ Binding_ WG - Reference
OpenID Connect Discovery 1.0 - Section 3