Rename a user

POST

/admin/users/{username}/rename

Authorizations

• BasicAuth
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Parameters

Path Parameters

username

required

string

Existing username of user

Request Body

RenameUserOption options when renaming a user

object

new_username

required

New username for this user. This name cannot be in use yet by any other user.

string

unique items

Example ^generated

{
  "new_username": "example"
}

RenameUserOption options when renaming a user

object

new_username

required

New username for this user. This name cannot be in use yet by any other user.

string

unique items

Responses

204

APIEmpty is an empty response

Media type application/json

403

APIForbiddenError is a forbidden error response

Media type application/json

object

message

string

url

string

Example ^generated

{
  "message": "example",
  "url": "example"
}

422

APIValidationError is error format response related to input validation

Media type application/json

object

message

string

url

string

Example ^generated

{
  "message": "example",
  "url": "example"
}