Update the username for a user

PATCH/admin/users/{username}

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Request

Path Parameters

username string required

Body Params

required

application/jsonobject

required

The user's new username.

Responses

application/json object

Response

message string

optional

url string

optional

Response Example: 202 application/json

{
  "message": "Job queued to rename user. It may take a few minutes to complete.",
  "url": "https://api.github.com/user/1"
}

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

username *

Request Sample: Shell / cURL

curl --request PATCH \
  --url {protocol}://{hostname}/api/v3/admin/users/{username} \
  --header 'content-type: application/json' \
  --data '{
  "login": "thenewmonalisa"
}'