Sign in
Users

Updates information about a user for the specified username and organization shortname (accessible to all registered users)

<h2>Access Control</h2> <p>All registered users can access this endpoint</p> <h2>Expected Behavior</h2> <p><b>Regular User:</b> Updates the user's own information. Only name fields may be changed.</p> <p><b>Admin User:</b> Updates information about a user in the Admin's organization. Allowed to change all fields except org_short_name. </p> <p><b>Secretariat:</b> Updates information about a user in any organization. Allowed to change all fields.</p>
put/org/{shortname}/user/{username}

Path parameters

shortnamestring required

The shortname of the organization

usernamestring required

The username of the user

Query parameters

activeboolean

The new active state for the user entry. Accepted values are 1, true, or yes to indicate true, and 0, false, or no to indicate false

active_roles.add'ADMIN'

Add an active role to the user

active_roles.remove'ADMIN'

Remove an active role from the user

name.firststring

The new first name for the user entry

name.laststring

The new last name for the user entry

name.middlestring

The new middle name for the user entry

name.suffixstring

The new suffix for the user entry

new_usernamestring

The new username for the user, preferably the user's email address. Must be 3-128 characters in length; allowed characters are alphanumeric and -_@.

org_short_namestring

The new organization for the user

registryboolean

When set to true, the endpoint will expect request data to conform to the applicable User Registry schema, and will provide response data conforming to the applicable User Registry schema. Defaults to false.

Headers

CVE-API-ORGstring required

The shortname for the organization associated with the user requesting authentication

CVE-API-USERstring required

The username for the account making the request

CVE-API-KEYstring required

The user's API key

Response

Returns the updated user information

UpdateUserResponseJson required— unresolved $ref

Changes