Rotate another role's API key

Replaces the API key of another role that you can update with a new random API key. The new API key is returned as the response body.

URI

PUT /authn/{account}/api_key?role={kind}:{identifier}

Any identifier included in the URL must be URL-encoded to be recognized by the Conjur API.

Examples:

Kinds of Roles

Kind	Description
User	One unique human
Host	A single logical machine (in the broad sense, not just physical)
Layer	A collection of hosts that have the same privileges
Group	A collection of users and groups that have the same privileges
Policy	A role that owns of a set of related objects

Permissions required

update privilege on the role whose API key is being rotated.

Suppose your account is myorg and you want to rotate the API key for user alice whose current password is Mypassw0rD1!:

curl --request PUT --data "" \
     -H "$(conjur authn authenticate -H)" \
     https://eval.conjur.org/authn/myorg/api_key?role=user:alice

Field	Description	Example
Authorization	Supported basic auth credentials: password (for users), API key, and access token.	Basic ZGFuaWVsOjlwOG5mc2RhZmJw

Code	Description
200	The response body is the API key
401	The credentials were not accepted
403	The caller does not have sufficient permission to perform this action
404	The target role does not exist or the caller does not have permission to see the target's role
405	The target role does not have an API key

PUT {{ConjurURL}}/authn/myorg/api_key?role=user:alice

Parameter	Type	Mandatory	Description
account	String	Yes	Organization account name. Example: `myorg`
kind	String	Yes	The kind of the role whose API key we will rotate, usually “user” or “host” Example: `user`
identifier	String	Yes	The ID of the role Example: `alice`

Parameter

Type

Mandatory

Description

account

String

Yes

Organization account name.

Example: myorg

kind

String

Yes

The kind of the role whose API key we will rotate, usually “user” or “host”

Example: user

identifier

String

Yes

The ID of the role

Example: alice

Headers

Authorization: Basic ZGFuaWVsOjlwOG5mc2RhZmJw

Requests that rotate a role's own API key must use their password (for users) or their existing API key (for hosts and users).

Headers

Content-Type: text/plain; charset=utf-8

Body

14m9cf91wfsesv1kkhevg12cdywm2wvqy6s8sk53z1ngtazp1t9tykc