Delete OIDC Client

DELETE 
/v3/config/extension/oidc/client/:clientId

Permanently removes an OpenID Connect client and its associated configuration. This action cannot be undone. System-managed clients cannot be deleted.

Request

Path Parameters

clientId stringrequired

The ID of the client

Responses

204

Client deleted

Response Headers

400

Bad request. The Passwordless Login extension is not enabled.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

403

The client is system-managed and cannot be deleted

Response Headers

application/json

Schema

Schema

error string

The error code, for example invalid_request, not_found or server_error

error_description string

The reason for the error

Example (from schema)

{
  "error": "string",
  "error_description": "string"
}

Example

{
  "error": "forbidden",
  "error_description": "System managed client cannot be deleted"
}

500

Internal server error. The provider also answers with this status when no client has the given ID. The answer has errorCode and errorDescription when it cannot reach the provider.

Response Headers

application/json

Schema

Schema

oneOf
Provider error
error string
The error code, for example invalid_request, not_found or server_error
error_description string
The reason for the error
API error
errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "error": "server_error",
  "error_description": "Internal server error"
}

Loading...