Delete a CIMD Client Registration API

Edit on GitHubView Markdown
On this page
Enterprise plan required

This feature requires an Enterprise plan.

Available since 1.70.0

This API is used to delete a CIMD client registration. You must specify the Id of the registration on the URI.

Caution

This is always a permanent, hard delete and cannot be reversed. Deleting a registration also deletes the client's refresh tokens.

Deleting a registration doesn't block the client. The next time a user logs in with the client, FusionAuth fetches its metadata document and registers it again. To keep a client out, set the decision to DENY for it in the CIMD domain's registration lambda. See Removing A CIMD Client.

Request#

API Key Authentication
Permanently delete a CIMD Client Registration. This operation cannot be reversed.
DELETE/api/cimd/registration/{registrationId}

Request Headers#

X-FusionAuth-TenantId
  • Type: String
  • Optional

The unique Id of the tenant used to scope this API request.

The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon other values in the request or it is otherwise not required.

Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

See Making an API request using a Tenant Id for additional information.

Request Parameters#

registrationId
  • Type: UUID
  • Required

The Id of the CIMD client registration to delete.

Response#

This API does not return a JSON response body.

Response Codes
CodeDescription
200The request was successful.
400The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404The object you requested doesn't exist. The response will be empty.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.