POST v2/api/api-credentials/{id}/enabled

(Re)enable/disable the specified API credential. Only either the Interactive User who owns the specified API Credential or their associated Administrator can call this method, otherwise 403:Forbidden is returned.

Request Information

Parameters

NameDescriptionAdditional information
id 
The identifier of the specified API Credential.

Define this parameter in the request URI.
newStateInput 
No documentation available.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample: 
{
  "Enabled": "sample string 1"
}

Response Information

The newly updated API Credential is returned. This end-point can only be called by either the Interactive User who owns the specified API Credential or their associated Administrator, otherwise a 403:Forbidden is returned. If the Interactive User is disabled a 400:BadRequest is returned. If the specified API Credential is not known a 404:NotFound is returned.

Response body formats

application/json, text/json

Sample: 
{
  "Id": "eb3523a3-d120-4d0a-86ca-2b457716ae31",
  "Enabled": true,
  "Created": "2024-11-21T10:12:51.348004+00:00"
}