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

Updates the name of the specified Interactive User to another valid name. This API call can be made by either the Administrator who created the target user or the target user themselves, otherwise a 403:Forbidden is returned.

Request Information

Parameters

Name	Description	Additional information
id	The identifier of the target user.	Define this parameter in the request URI.
newName	The new name.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "Name": "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 name must less than 255 characters, 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": "74f0a9c1-e818-4435-b5db-81222d0810e3",
  "Name": "sample string 2",
  "Username": "sample string 3",
  "Role": "sample string 4",
  "Credentials": [
    {
      "Id": "ad7ab0b2-ecb2-4605-8fda-140f56eff2b6",
      "Enabled": true,
      "Created": "2024-11-21T10:00:16.0495587+00:00"
    },
    {
      "Id": "ad7ab0b2-ecb2-4605-8fda-140f56eff2b6",
      "Enabled": true,
      "Created": "2024-11-21T10:00:16.0495587+00:00"
    },
    {
      "Id": "ad7ab0b2-ecb2-4605-8fda-140f56eff2b6",
      "Enabled": true,
      "Created": "2024-11-21T10:00:16.0495587+00:00"
    }
  ],
  "Enabled": true,
  "Created": "2024-11-21T10:00:16.0495587+00:00"
}