apiKey_update

PUT /users/{uid}/apikeys/{akid}

Updates an API key.

Note

Only the optional meta-data name and description can be updated. The actual key pair information will not be changed.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: api_key_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • akid (required): the id of the apiKeyPair to delete

HTTP Request Body Parameters

A apiKeyPair object

Example Request

curl "https://uforge.example.com/api/users/{uid}/apikeys/{akid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):