oauth2.dev

client_uri

IESG

Registry Context

`client_uri` is optional client metadata containing the URL of a webpage with information about the client. Clients are recommended to provide it. When present, the server should display it to the end user as a clickable link, and it must point to a valid webpage.

Technical Summary

RFC 7591 defines `client_uri` as a URL string identifying a webpage that provides information about the client. The field is optional, clients are RECOMMENDED to send it, servers SHOULD display it as a clickable URL when present, and its value MUST point to a valid webpage. It MAY be internationalized using the human-readable metadata conventions in Section 2.2.

When Used

As client metadata in dynamic client registration requests and registration responses.

Normative Requirements

Clients

RECOMMENDED
2
  1. RFC 7591 - Section 2

    Always send the `client_uri` field..

    It is RECOMMENDED that clients always send this field.

  2. RFC 7591 - Section 2.2

    Spell BCP 47 language tags in metadata member names using the character case registered in the IANA Language Subtag Registry..

    Condition: When supplying a language-tagged `client_uri` member name.

    It is RECOMMENDED that language tag values used in Claim Names be spelled using the character case with which they are registered.

MAY
1
  1. RFC 7591 - Section 2

    Internationalize the `client_uri` value as described in Section 2.2..

    The value of this field MAY be internationalized, as described in Section 2.2.

Client metadata

MAY
1
  1. RFC 7591 - Section 2.2

    Represent human-readable client metadata values, including `client_uri`, in multiple languages and scripts..

    Human-readable client metadata values and client metadata values that reference human-readable values MAY be represented in multiple languages and scripts.

Implementations

SHOULD
1
  1. RFC 7591 - Section 2.2

    Interpret language-tag values case-insensitively..

    Condition: When processing a language-tagged `client_uri` member name.

    Implementations SHOULD interpret the language tag values supplied in a case insensitive manner.

OPTIONAL
1
  1. RFC 7591 - Section 2

    Implement and use the `client_uri` metadata field..

    Condition: Unless stated otherwise by an applicable specification.

    The implementation and use of all client metadata fields is OPTIONAL, unless stated otherwise.

authorization servers

SHOULD
1
  1. RFC 7591 - Section 2

    Display the `client_uri` URL to the end user in a clickable fashion..

    Condition: When `client_uri` is present.

    If present, the server SHOULD display this URL to the end-user in a clickable fashion.

clients and servers

RECOMMENDED
2
  1. RFC 7591 - Section 2.2

    Use an untagged `client_uri` field in addition to any language-specific variants..

    Condition: When language-specific variants are used.

    It is RECOMMENDED that clients and servers use a human-readable field without any language tags in addition to any language-specific fields.

  2. RFC 7591 - Section 2.2

    Ensure an untagged `client_uri` value is suitable for display on a wide variety of systems..

    Condition: When sending `client_uri` without a language tag.

    It is RECOMMENDED that any human-readable fields sent without language tags contain values suitable for display on a wide variety of systems.

parties presenting the metadata

MUST
1
  1. RFC 7591 - Section 2.2

    Use an untagged `client_uri` string value as-is wherever it is presented in a user interface..

    Condition: When `client_uri` is sent without a language tag.

    The string value MUST be used as is wherever it is presented in a user interface.

parties using the metadata

MUST NOT
1
  1. RFC 7591 - Section 2.2

    Make assumptions about the language, character set, or script of an untagged `client_uri` value..

    Condition: When `client_uri` is sent without a language tag.

    Parties using it MUST NOT make any assumptions about the language, character set, or script of the string value.

the `client_uri` value

MUST
1
  1. RFC 7591 - Section 2

    Point to a valid webpage..

    The value of this field MUST point to a valid web page.

Validation Guidance

error

Verify that `client_uri` is a URL string pointing to a valid webpage.

info

When localized variants are supported, accept BCP 47 language tags appended to the member name with `#` and interpret those tags case-insensitively.

warning

When localized variants are provided, check for an additional untagged `client_uri` value suitable for broad display.

error

Do not infer the language, character set, or script of an untagged `client_uri`; preserve its value when presenting it.

warning

When displaying `client_uri` to an end user, render it as a clickable link.

Reference

Details

Entry Id
client_uri
Client Metadata Name
client_uri
Client Metadata Description
URL of a web page providing information about the client
Change Controller
IESG
Reference
RFC7591