oauth2.dev

_claim_names

OpenID_Foundation_Artifact_Binding_Working_Group

Registry Context

`_claim_names` identifies which aggregated or distributed claims are supplied by entries in `_claim_sources`. Its member names are claim names, and its member values reference source identifiers in `_claim_sources`.

Technical Summary

A JSON object used with `_claim_sources` for aggregated and distributed claims. The object maps claim names to `_claim_sources` member names from which claim values can be retrieved.

When Used

Used in OpenID Connect aggregated and distributed claims responses when claim values are supplied by referenced claim sources rather than directly in the containing claims object.

Normative Requirements

Aggregated Claims JWT

MUST
1
  1. openid-connect-core-1_0 - Section 5.6.2

    contain all claims in the `_claim_names` object that reference the corresponding `_claim_sources` member.

    Condition: when a `_claim_sources` member provides aggregated claims using a JWT member

    JWT that MUST contain all the Claims in the _claim_names object that references the corresponding _claim_sources member.

OP

MAY
1
  1. openid-connect-core-1_0 - Section 5.6.2

    omit some claims available from referenced Claims Providers from the set of claim names represented in `_claim_names`.

    Condition: when using aggregated or distributed claims with referenced Claims Providers

    The OP MAY omit some Claims available from referenced Claims Providers from the set of Claim Names.

Validation Guidance

error

Verify `_claim_names` is a JSON object whose member names are claim names and whose member values refer to member names in `_claim_sources`.

error

When validating an aggregated-claims JWT, verify it contains every claim referenced by `_claim_names` for the corresponding `_claim_sources` entry.

info

Do not treat omitted available claims from referenced Claims Providers as an error solely because they were omitted from `_claim_names`.

Reference

Details

Entry Id
_claim_names
Claim Name
_claim_names
Claim Description
JSON object whose member names are the Claim Names for the Aggregated and Distributed Claims
Change Controller
OpenID_Foundation_Artifact_Binding_Working_Group
Reference
OpenID Connect Core 1.0 - Section 5.6.2