Skip to content
forgit api docs

Create a user account

POST
/admin/users

Authorizations

Section titled “ Authorizations ”

Request Body

Section titled “ Request Body ”
Media type application/json

CreateUserOption create user options

object
created_at

For explicitly setting the user creation timestamp. Useful when users are migrated from other systems. When omitted, the user’s creation timestamp will be set to “now”.

string format: date-time
email
required
string format: email
full_name
string
login_name
string
must_change_password
boolean
password
string
restricted
boolean
send_notify
boolean
source_id
integer format: int64
username
required
string
visibility
string
Example generated 
{
  "created_at": "2026-04-15T12:00:00Z",
  "email": "hello@example.com",
  "full_name": "example",
  "login_name": "example",
  "must_change_password": true,
  "password": "example",
  "restricted": true,
  "send_notify": true,
  "source_id": 1,
  "username": "example",
  "visibility": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “ 201 ”

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

Section titled “ 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

Section titled “ 403 ”

APIForbiddenError is a forbidden error response

Media type application/json
object
message
string
url
string
Example generated 
{
  "message": "example",
  "url": "example"
}

422

Section titled “ 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"
}