Set Consumer Secret Key

Endpoint

PUT /apiops/projects/{projectName}/consumers/{consumerKey}/secret-key/{secretKeyName}

Authentication

Requires a Personal API Access Token.

Authorization: Bearer YOUR_TOKEN

Request

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name
consumerKey	string	Yes	Consumer key
secretKeyName	string	Yes	Name of the secret key. The project's own object is used first, then the one of the administration project. An unknown name answers 404 resourceNotFound

The request has no body.

Warning

A consumer that a live identity source manages (LDAP, OIDC, database or API sync) cannot be edited. The request answers 400 malformedRequest with params.reason = ldapManaged. Change such a consumer in the identity source.

Response

200 OK.

The response is a write response. result is the consumer. runtimeDeployment.state is IN_SYNC when every environment acknowledged the change, or DEGRADED when the change is stored but at least one environment did not acknowledge it. Do not retry a DEGRADED write; redeploy instead. resourceVersion is not returned.

cURL Example

curl -X PUT \
  "https://demo.apinizer.com/apiops/projects/MyProject/consumers/CONSUMER_KEY/secret-key/MyObject" \
  -H "Authorization: Bearer YOUR_TOKEN"

Permissions

• User must have IDENTITY + MANAGE permission in the project
• A project outside the scope of the caller answers 404 resourceNotFound, never 403
• The admin project has no consumers: a call on it answers 400 malformedRequest (params.reason = platformScopeNotSupported)

Related Documentation

• Remove Consumer Secret Key