Ana içeriğe geç

Remove Consumer Keystore

Endpoint​

DELETE /apiops/projects/{projectName}/consumers/{consumerKey}/keystore

Authentication​

Requires a Personal API Access Token.

Authorization: Bearer YOUR_TOKEN

Request​

Path Parameters​

ParameterTypeRequiredDescription
projectNamestringYesProject name
consumerKeystringYesConsumer key, assigned by the installation. Returned as consumerKey by every consumer response

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.

A consumer that has no keystore assigned answers 404 resourceNotFound (params.reason = materialNotAssigned).

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.

cURL Example​

curl -X DELETE \
"https://demo.apinizer.com/apiops/projects/MyProject/consumers/CONSUMER_KEY/keystore" \
-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)