Skip to main content

Update a user (v2)

PUT 

/tap/api/v2/users/:userId

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Deprecated; use PUT /tap/api/v3/users/{userId}. Differs from v3 only in awsRoles: the request accepts AWS role objects, of which only id is read, as well as AWS role ids, and the response lists AWS role objects. Updates a user. Only the fields present in the request body are changed; a field sent as null is treated as omitted. Allowed for an admin or the user themselves; only an admin may change userRole, active, commonName, or awsRoles (a non-admin may send them unchanged). An AWS role id the user does not already have must belong to an existing AWS role. Group memberships are updated when fullName, email, or userRole changes. Changing commonName or fullName does not issue a new certificate; use POST /tap/api/v3/users/{userId}/certificate. Certificate files are stored under a name derived from fullName, so after fullName changes, download links point to a bundle that does not exist and POST /tap/api/v3/users/{userId}/certificate/bundle builds a bundle without the user's certificate until the certificate is rebuilt. bundlePath in the response is the stored location of the certificate bundle, not a download link.

Request​

Responses​

The result of the update. When the change could not be saved, success is false and data is absent; this includes a userRole that is not exactly user, admin, or super_admin.