Consumer

Update a consumer

Updates the consumer and redeploys it. A field the body omits (null) keeps its stored value; send an empty list or an empty string to clear one; send "expireDate": null to remove the expiry. A consumer a live identity source manages cannot be edited (400); actions/enable and actions/disable still apply. username and consumerKey cannot change (400 immutableField). The password changes only through actions/change-password and the organization only through actions/transfer-organization. metadata, when sent, replaces the stored list; secret values are write-only, so a secret entry sent without a value is stored empty — send the value to keep it.

put/apiops/projects/{projectName}/consumers/{consumerKey}

Request

Path parameters

projectNamestring required
consumerKeystring required

Request body

consumerKeystring
usernamestring
passwordstring
fullNamestring
emailstring
descriptionstring
enabledboolean
ipListstring[]
expireDatestring date-time
roleNameListstring[]
trafficLogDisabledboolean
organizationCodestring

Response

OK

status'SUCCESS' | 'FAILURE'
resourceVersioninteger

Changes

No recorded changes to this operation across all 21 revisions of this API.