Deprovision a client registration (RFC 7592)

DELETE/register/{client_id}

Deletes the client and revokes its issued tokens. Returns 204.

DELETE/register/{client_id}

curl -g -X DELETE 'https://auth.example.com/register/{client_id}' \
  -H "Authorization: Bearer $REGISTRATION_ACCESS_TOKEN"

Response

204 No Content

No response body.

Authorization

Registration access token

Send it in the Authorization header:

The access token, as Bearer <token> (RFC 6750 §2.1) or, for a sender-constrained token, DPoP <token> (RFC 9449 §7.1). A token minted with a cnf.jkt confirmation is only accepted together with a DPoP proof signed by that key, whichever of the two schemes carries it.

Path parameters

client_idstringrequired
The registered client identifier.
1–256 characters · pattern ^[!-~]+$

Responses

204 No ContentThe client was deleted.
The client was deleted.
Headers
- Cache-Controlno-store
- Pragmano-cache
401 Unauthorizedapplication/jsonRegistration error (RFC 7591 §3.2.2).
Registration error (RFC 7591 §3.2.2).
Headers
- Cache-Controlno-store
- WWW-Authenticatestring
- DPoP-Noncestring
Body
A dynamic client registration error (RFC 7591 §3.2.2).
- errorenumrequired
  Possible values"invalid_redirect_uri""invalid_client_metadata""invalid_software_statement""unapproved_software_statement""invalid_token""access_denied""temporarily_unavailable"
- error_descriptionstring
  Example"token_endpoint_auth_method is not supported"
429 Too Many Requestsapplication/problem+jsonToo many requests.
Too many requests.
Body
RFC 9457 (formerly RFC 7807) problem details (application/problem+json). code is a stable machine-readable slug for the problem kind (it mirrors the suffix of type), so consumers can branch on it without parsing prose. errors is present on validation failures and lists every offending field.
- titlestringrequired
  Example"Request validation failed"
- statusintegerrequired
  Example400
- typestring · uri
  Example"urn:problem-type:validation_error"
- detailstring
  Example"One or more fields did not satisfy the API schema."
- codeenum
  The kind of problem, as a stable machine-readable slug a client branches on and translates rather than parsing title or detail, which are English prose for logs. A problem whose status says everything the server knows carries no code.
  Show moreShow less
  validation_error is the one code whose message is not a sentence about the code itself: the request failed the schema, and the specifics are the errors list — one entry per offending field — which a form renders on those fields. required and malformed are spelled like two of the per-field violation codes (FieldError.code) but mean something else; the two vocabularies are told apart by position, never by spelling.
  
  Compatibility: this is a CLOSED enum, with the same cost as AuditAction: a client generated against an older version of this document rejects a problem carrying a code added after it was built. Regenerate on upgrade, or decode the field as a plain string. It is enumerated anyway so that what a client must translate is knowable from the contract alone.
  Possible values"invalid_request""invalid_credentials""forbidden""unauthorized""insufficient_user_authentication""protected_account""last_role_administrator""invalid_code""too_many_requests""too_many_attempts""account_locked""account_unavailable""already_enrolled""registration_disabled""registration_conflict""captcha_failed""invalid_reset_link""invalid_verification_link""invalid_invitation_link""mail_relay_missing""not_found""conflict""unavailable""busy""window_too_large""too_many_series""internal_error""rate_limited""malformed""body_too_large""required""validation_error""unknown_org""invalid_token""invalid_dpop_proof""use_dpop_nonce""server_error"
- instancestring
  Example"/introspect"
- request_idstring
  Example"8d94ed49-1caf-4ab3-9594-557142f2d023"
- trace_idstring
  Distributed-trace id (hex) for correlating this response with traces and logs. Present only when tracing is enabled and the request was recorded. Opaque and safe to log/share.
  Example"4bf92f3577b34da6a3ce929d0e0e4736"
- errorsarray of objects
  Field-level violations (present for validation errors).
  Each item:
  A single field-level validation violation.
  Show item attributesHide item attributes
  fieldstringrequired
  Offending field, dotted for nested bodies (e.g. child.id).
  Example"token_type_hint"
  codestringrequired
  Machine-readable violation code: required, too_short, too_long, pattern, invalid_format, not_allowed, minimum, maximum, multiple_of, too_few, too_many, not_unique, malformed.
  Example"not_allowed"
  messagestringrequired
  Example"field token_type_hint must be one of [access_token, refresh_token]"
Errorapplication/jsonRegistration error (RFC 7591 §3.2.2).
Registration error (RFC 7591 §3.2.2).
Headers
- Cache-Controlno-store
- WWW-Authenticatestring
- DPoP-Noncestring
Body
A dynamic client registration error (RFC 7591 §3.2.2).
- errorenumrequired
  Possible values"invalid_redirect_uri""invalid_client_metadata""invalid_software_statement""unapproved_software_statement""invalid_token""access_denied""temporarily_unavailable"
- error_descriptionstring
  Example"token_endpoint_auth_method is not supported"

PreviousUpdate a client registration NextInteractive

Deprovision a client registration (RFC 7592)

DELETE/register/{client_id}

Registration access token Rate limited

Deletes the client and revokes its issued tokens. Returns 204.

DELETE/register/{client_id}

curl -g -X DELETE 'https://auth.example.com/register/{client_id}' \
  -H "Authorization: Bearer $REGISTRATION_ACCESS_TOKEN"

Response

204 No Content

No response body.

Authorization

Registration access token

Send it in the Authorization header:

Path parameters

client_idstringrequired
The registered client identifier.
1–256 characters · pattern ^[!-~]+$

Responses

204 No ContentThe client was deleted.
The client was deleted.
Headers
- Cache-Controlno-store
- Pragmano-cache
401 Unauthorizedapplication/jsonRegistration error (RFC 7591 §3.2.2).
Registration error (RFC 7591 §3.2.2).
Headers
- Cache-Controlno-store
- WWW-Authenticatestring
- DPoP-Noncestring
Body
A dynamic client registration error (RFC 7591 §3.2.2).
- errorenumrequired
  Possible values"invalid_redirect_uri""invalid_client_metadata""invalid_software_statement""unapproved_software_statement""invalid_token""access_denied""temporarily_unavailable"
- error_descriptionstring
  Example"token_endpoint_auth_method is not supported"
429 Too Many Requestsapplication/problem+jsonToo many requests.
Too many requests.
Body
RFC 9457 (formerly RFC 7807) problem details (application/problem+json). code is a stable machine-readable slug for the problem kind (it mirrors the suffix of type), so consumers can branch on it without parsing prose. errors is present on validation failures and lists every offending field.
- titlestringrequired
  Example"Request validation failed"
- statusintegerrequired
  Example400
- typestring · uri
  Example"urn:problem-type:validation_error"
- detailstring
  Example"One or more fields did not satisfy the API schema."
- codeenum
  The kind of problem, as a stable machine-readable slug a client branches on and translates rather than parsing title or detail, which are English prose for logs. A problem whose status says everything the server knows carries no code.
  Show moreShow less
  validation_error is the one code whose message is not a sentence about the code itself: the request failed the schema, and the specifics are the errors list — one entry per offending field — which a form renders on those fields. required and malformed are spelled like two of the per-field violation codes (FieldError.code) but mean something else; the two vocabularies are told apart by position, never by spelling.
  
  Compatibility: this is a CLOSED enum, with the same cost as AuditAction: a client generated against an older version of this document rejects a problem carrying a code added after it was built. Regenerate on upgrade, or decode the field as a plain string. It is enumerated anyway so that what a client must translate is knowable from the contract alone.
  Possible values"invalid_request""invalid_credentials""forbidden""unauthorized""insufficient_user_authentication""protected_account""last_role_administrator""invalid_code""too_many_requests""too_many_attempts""account_locked""account_unavailable""already_enrolled""registration_disabled""registration_conflict""captcha_failed""invalid_reset_link""invalid_verification_link""invalid_invitation_link""mail_relay_missing""not_found""conflict""unavailable""busy""window_too_large""too_many_series""internal_error""rate_limited""malformed""body_too_large""required""validation_error""unknown_org""invalid_token""invalid_dpop_proof""use_dpop_nonce""server_error"
- instancestring
  Example"/introspect"
- request_idstring
  Example"8d94ed49-1caf-4ab3-9594-557142f2d023"
- trace_idstring
  Distributed-trace id (hex) for correlating this response with traces and logs. Present only when tracing is enabled and the request was recorded. Opaque and safe to log/share.
  Example"4bf92f3577b34da6a3ce929d0e0e4736"
- errorsarray of objects
  Field-level violations (present for validation errors).
  Each item:
  A single field-level validation violation.
  Show item attributesHide item attributes
  fieldstringrequired
  Offending field, dotted for nested bodies (e.g. child.id).
  Example"token_type_hint"
  codestringrequired
  Machine-readable violation code: required, too_short, too_long, pattern, invalid_format, not_allowed, minimum, maximum, multiple_of, too_few, too_many, not_unique, malformed.
  Example"not_allowed"
  messagestringrequired
  Example"field token_type_hint must be one of [access_token, refresh_token]"
Errorapplication/jsonRegistration error (RFC 7591 §3.2.2).
Registration error (RFC 7591 §3.2.2).
Headers
- Cache-Controlno-store
- WWW-Authenticatestring
- DPoP-Noncestring
Body
A dynamic client registration error (RFC 7591 §3.2.2).
- errorenumrequired
  Possible values"invalid_redirect_uri""invalid_client_metadata""invalid_software_statement""unapproved_software_statement""invalid_token""access_denied""temporarily_unavailable"
- error_descriptionstring
  Example"token_endpoint_auth_method is not supported"

PreviousUpdate a client registration NextInteractive

Authorization

Path parameters

Responses

Headers

Headers

Body

Body

Headers

Body

Authorization

Path parameters

Responses

Headers

Headers

Body

Body

Headers

Body