Edit an existing user

PATCH

/admin/users/{username}

Authorizations

• BasicAuth
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Parameters

Path Parameters

username

required

string

Username of user to edit

Request Body

Media type application/json

EditUserOption edit user options

object

active

boolean

admin

boolean

allow_create_organization

boolean

allow_git_hook

boolean

allow_import_local

boolean

description

string

email

string format: email

full_name

string

hide_email

boolean

location

string

login_name

string

max_repo_creation

integer format: int64

must_change_password

boolean

password

string

prohibit_login

boolean

pronouns

string

restricted

boolean

source_id

integer format: int64

visibility

string

website

string

Example ^generated

{
  "active": true,
  "admin": true,
  "allow_create_organization": true,
  "allow_git_hook": true,
  "allow_import_local": true,
  "description": "example",
  "email": "hello@example.com",
  "full_name": "example",
  "hide_email": true,
  "location": "example",
  "login_name": "example",
  "max_repo_creation": 1,
  "must_change_password": true,
  "password": "example",
  "prohibit_login": true,
  "pronouns": "example",
  "restricted": true,
  "source_id": 1,
  "visibility": "example",
  "website": "example"
}

Responses

200

User

Media type application/json

User represents a user

object

active

Is user active

boolean

avatar_url

URL to the user’s avatar

string

created

string format: date-time

description

The user’s description

string

email

string format: email

followers_count

User counts

integer format: int64

following_count

integer format: int64

full_name

The user’s full name

string

html_url

URL to the user’s profile page

string

id

The user’s id

integer format: int64

is_admin

Is the user an administrator

boolean

language

User locale

string

last_login

string format: date-time

location

The user’s location

string

login

The user’s username

string

login_name

The user’s authentication sign-in name.

string

default: empty

prohibit_login

Is user login prohibited

boolean

pronouns

The user’s pronouns

string

restricted

Is user restricted

boolean

source_id

The ID of the user’s Authentication Source

integer format: int64

starred_repos_count

integer format: int64

visibility

User visibility level option: public, limited, private

string

website

The user’s website

string

Example

{
  "login_name": "empty"
}

400

APIError is error format response

Media type application/json

APIError is an api error with a message

object

message

string

url

string

Example ^generated

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

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"
}