changeActivation
changeActivation(clientId, ChangeClientActivationRequest)
PATCH /api/2.0/oauth2/clients/{clientId}/activation
Change client activation status
Enables or disables an existing client and answers 200 with an empty body. A disabled client can no longer obtain new tokens, but the tokens and consents it already holds stay valid until they expire on their own: disable a client to stop new authorizations, delete it to end the existing ones. An administrator may change any client of the tenant, a plain user only the clients they created. The body carries the single activation flag, and a client the caller may not see is reported as not found rather than as forbidden.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| clientId | path | String | ID of the client to change activation for | [required] [example: 6c7cf17b-1bd3-47d5-94c6-be2d3570e168] [minLength: 1] |
| ChangeClientActivationRequest | body | ChangeClientActivationRequest | [required] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | Client activation status successfully changed | - | - |
| 400 | The client ID is blank, or the activation status is missing | ProblemDetail | - |
| 403 | Insufficient permissions to change client activation | ProblemDetail | - |
| 404 | No client with this ID is visible to the caller, or the ID cannot be parsed as a client ID | ProblemDetail | - |
| 415 | The Content-Type header is not application/json | ProblemDetail | - |
| 429 | Too many requests - rate limit exceeded | ProblemDetail | - |
| 500 | Internal server error occurred | ProblemDetail | - |
| 405 | The HTTP method is not allowed for this path | ProblemDetail | - |
| 406 | The Accept header does not allow application/json | ProblemDetail | - |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json