POST v2/api/users/{id}/username

Updates the username of the specified Interactive User. This API call can be made by either the Administrator who created the target user or the target user themselves.

Request Information

Parameters

Name	Description	Additional information
id	The identifier of the target user.	Define this parameter in the request URI.
newUsername	The email address which will become the user's username.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "Username": "sample string 1"
}

Response Information

The newly updated Interactive User with their API Credentials is returned. This endpoint can only be called by neither the Administrator who created the target user or the target user themselves, otherwise a 403:Forbidden is returned. The user's username must be less than 255 characters and unique, otherwise a 400:BadRequest is returned. If the target user is disabled a 400:BadRequest is returned.

Response body formats

application/json, text/json

Sample:

{
  "Id": "59c149b1-67e1-4e54-8fb6-1281a048a2fd",
  "Name": "sample string 2",
  "Username": "sample string 3",
  "Role": "sample string 4",
  "Credentials": [
    {
      "Id": "1d16039a-895b-4e41-9816-b3da0bdff9f7",
      "Enabled": true,
      "Created": "2024-11-21T11:25:56.8492786+00:00"
    },
    {
      "Id": "1d16039a-895b-4e41-9816-b3da0bdff9f7",
      "Enabled": true,
      "Created": "2024-11-21T11:25:56.8492786+00:00"
    },
    {
      "Id": "1d16039a-895b-4e41-9816-b3da0bdff9f7",
      "Enabled": true,
      "Created": "2024-11-21T11:25:56.8492786+00:00"
    }
  ],
  "Enabled": true,
  "Created": "2024-11-21T11:25:56.8492786+00:00"
}