oauth2.dev

address

OpenID_Foundation_Artifact_Binding_Working_Group

Registry Context

The address claim is the End-User's preferred postal address, represented as a JSON object whose members contain postal address fields.

Technical Summary

OpenID Connect Core defines address as a Standard Claim with JSON object value. Section 5.1.1 defines the Address Claim as a physical mailing address and permits partial address disclosure, formatted-only representation, component-only representation, or both.

When Used

Used when an OpenID Connect Provider returns an End-User postal address in a UserInfo Response or ID Token.

Normative Requirements

Implementations

SHOULD
1
  1. openid-connect-core-1_0 - Section 5.1.1

    make the formatted address and component fields represent the same address, with the formatted address indicating how the component fields are combined.

    Condition: if both variants are returned

    If both variants are returned, they SHOULD represent the same address, with the formatted address indicating how the component fields are combined.

MAY
4
  1. openid-connect-core-1_0 - Section 5.1.1

    return only a subset of the fields of an address.

    Condition: depending upon the information available and the End-User's privacy preferences

    Implementations MAY return only a subset of the fields of an address, depending upon the information available and the End-User's privacy preferences.

  2. openid-connect-core-1_0 - Section 5.1.1

    return just the full address as a single string in the formatted sub-field.

    Implementations MAY return just the full address as a single string in the formatted sub-field

  3. openid-connect-core-1_0 - Section 5.1.1

    return just the individual component fields using the other sub-fields.

    or they MAY return just the individual component fields using the other sub-fields

  4. openid-connect-core-1_0 - Section 5.1.1

    return both the formatted address and individual component fields.

    or they MAY return both.

Unspecified actor

MAY
3
  1. openid-connect-core-1_0 - Section 5.1.1

    contain multiple lines separated by newlines in the formatted field.

    Condition: for the full mailing address formatted for display or use on a mailing label

    This field MAY contain multiple lines, separated by newlines.

  2. openid-connect-core-1_0 - Section 5.1.1

    include house number, street name, Post Office Box, and multi-line extended street address information in the full street address component.

    Full street address component, which MAY include house number, street name, Post Office Box, and multi-line extended street address information.

  3. openid-connect-core-1_0 - Section 5.1.1

    contain multiple lines separated by newlines in the full street address component.

    This field MAY contain multiple lines, separated by newlines.

Validation Guidance

info

Accept address as a JSON object containing some or all address members defined by OpenID Connect Core Section 5.1.1.

error

Do not require every address sub-field to be present; partial address disclosure is permitted.

warning

If both formatted and component fields are present, check that they are consistent representations of the same postal address when validation has enough context to compare them.

error

Allow newlines in formatted and street_address values.

Security Notes

openid-connect-core-1_0 - Section 5.1.1

Partial address returns can reflect End-User privacy preferences; validation should not force finer-grained address disclosure.

Reference

Details

Entry Id
address
Claim Name
address
Claim Description
Preferred postal address
Change Controller
OpenID_Foundation_Artifact_Binding_Working_Group
Reference
OpenID Connect Core 1.0 - Section 5.1