Update a user (v2)
PUT/tap/api/v2/users/:userId
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). Group memberships are updated when fullName, email, or userRole changes. Changing commonName or fullName does not issue a new certificate; use POST /tap/api/v2/users/{userId}/certificate. bundlePath in the response is the stored location of the certificate bundle, not a download link.
Request
Responses
- 200
- 400
- 403
- 404
- 422
- 500
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.
The caller has the admin role and the identifier is not a number, or the email is already used by another user. Emails are compared without regard to case.
The caller is not allowed to make this change: the caller is neither an admin nor the user, a non-admin tried to change an admin-only field, the caller tried to assign or modify a super_admin without being one, or reactivating the user would exceed the account user limit.
No user exists with the given identifier.
Email domain validation is on and the email domain is not allowed. The submitted email is checked, or the stored email when email is omitted; the check is skipped when the only change is to active.
The user could not be updated, including when the request body is not a JSON object.