Update a User

Learn about updating a user.

Update a user

EndpointMethodKey valueRequired fields
v2/users/{uuid}PUTuuiduuid

This request updates a user. All elements are replaced. All user details must be specified in the request.

Path parameter

ParameterDetailsDescription
uuidRequired
string
The UUID of the user to update

Sample request - Create user

{
  "username": "[email protected]",
  "email": "[email protected]",
  "fullName": "Joe Smith",
  "isDisabled": true,
  "passwordExpirationDisabled": false,
  "defaultPartition": {
    "uuid": "37f038e2-22ec-4e5b-93f4-f065bea65542",
    "name": "Vertex Cloud"
  },
  "partitionRoles": [
    {
      "partition": {
        "uuid": "37f038e2-22ec-4e5b-93f4-f065bea65542",
        "name": "Vertex Cloud"
      },
      "roles": [
        {
          "uuid": "37f038e2-22ec-4e5b-93f4-f065bea65542",
          "sourceId": 1,
          "name": "User Role Name",
          "description": "User Role Description"
        }
      ]
    }
  ],
  "password": "string",
  "passwordExpirationDate": "2020-01-01",
  "isSSOUser": false,
  "isServiceAccount": false,
  "locale": "en_US"
}

Sample response- Create user

{
  "uuid": "37f038e2-22ec-4e5b-93f4-f065bea65542",
  "username": "[email protected]",
  "email": "[email protected]",
  "fullName": "Joe Smith",
  "isDisabled": true,
  "passwordExpirationDisabled": false,
  "defaultPartition": {
    "uuid": "37f038e2-22ec-4e5b-93f4-f065bea65542",
    "name": "Vertex Cloud"
  },
  "partitionRoles": [
    {
      "partition": {
        "uuid": "37f038e2-22ec-4e5b-93f4-f065bea65542",
        "name": "Vertex Cloud"
      },
      "roles": [
        {
          "uuid": "37f038e2-22ec-4e5b-93f4-f065bea65542",
          "sourceId": 1,
          "name": "User Role Name",
          "description": "User Role Description"
        }
      ]
    }
  ],
  "passwordExpirationDate": "2020-01-01",
  "isSSOUser": false,
  "isServiceAccount": false,
  "locale": "en_US"
}