oauth2.dev

invalid_client_metadata

IETF

Registry Context

Returned when a client registration request contains an invalid client metadata field and the server rejects the request.

Technical Summary

RFC 7591 defines `invalid_client_metadata` for a rejected registration request in which at least one client metadata field has an invalid value.

When Used

When the server rejects a dynamic client registration request because a client metadata field is invalid. The server may instead substitute a valid value.

Normative Requirements

Authorization servers

MUST
1
  1. RFC 7591 - Section 2

    ignore client metadata sent by the client that it does not understand.

    MUST ignore any client metadata sent by the client that it does not understand

REQUIRED
1
  1. RFC 7591 - Section 3.2.2

    include an `error` member containing a single ASCII error code string.

    Condition: when constructing a client registration error response

    error REQUIRED. Single ASCII error code string.

MAY
2
  1. RFC 7591 - Section 3.2.2

    include other members in the error response JSON object.

    Condition: when constructing a client registration error response

    Other members MAY also be included

  2. RFC 7591 - Section 3.2.2

    substitute a valid value for any requested client metadata parameter.

    Condition: when a requested client metadata value is invalid

    MAY choose to substitute a valid value for any requested parameter

OPTIONAL
1
  1. RFC 7591 - Section 3.2.2

    include an `error_description` member containing human-readable ASCII text for debugging.

    Condition: when constructing a client registration error response

    error_description OPTIONAL.

recipient

MUST
1
  1. RFC 7591 - Section 3.2.2

    ignore other error response members that it does not understand.

    Condition: when processing a client registration error response

    if they are not understood, they MUST be ignored

Validation Guidance

error

Use the exact error code `invalid_client_metadata` only when a client metadata field is invalid and the server rejects the registration request.

error

For a registration error response, verify an HTTP 400 status unless otherwise specified, `Content-Type: application/json`, and a JSON response body.

error

Verify that the JSON error response includes an `error` member containing a single ASCII error code string.

error

Do not reject a request merely because it contains client metadata that the authorization server does not understand; such metadata must be ignored.

warning

If the server substitutes a valid metadata value instead of rejecting the request, do not emit `invalid_client_metadata`.

error

Ignore unrecognized additional members when consuming a client registration error response.

Reference

Details

Entry Id
invalid_client_metadata
Name
invalid_client_metadata
Usage Location
registration endpoint
Protocol Extension
Dynamic Client Registration
Change Controller
IETF
Reference
RFC7591 - Section 3.2.2