跳转到内容
Try Gitea Cloud ☁️ for 30 days → Accelerate your Development & Deploys!
This is the documentation of the next version, still under development. See the latest release.

Search users according filter conditions

GET
/admin/users
curl --request GET \
--url https://gitea.com/api/v1/admin/users \
--header 'Authorization: Basic <credentials>'
source_id
integer format: int64

ID of the user’s login source to search for

login_name
string

Identifier of the user, provided by the external authenticator

page
integer

Page number of results to return (1-based)

limit
integer

Page size of results

sort
string

Sort users by attribute. Supported values are “name”, “created”, “updated” and “id”. Default is “name”

order
string

Sort order, either “asc” (ascending) or “desc” (descending). Default is “asc”, ignored if “sort” is not specified.

q
string

Search term (username, full name, email)

visibility
string

Visibility filter. Supported values are “public”, “limited” and “private”.

is_active
boolean

Filter active users

is_admin
boolean

Filter admin users

is_restricted
boolean

Filter restricted users

is_2fa_enabled
boolean

Filter 2FA enabled users

is_prohibit_login
boolean

Filter login prohibited users

UserList

Media typeapplication/json
Array<object>

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 gitea 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

Login of the user, same as username

string
login_name

Identifier of the user, provided by the external authenticator (if configured)

string
default: empty
prohibit_login

Is user login prohibited

boolean
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
Allowed values: public limited private
website

The user’s website

string
Example
[
{
"login_name": "empty",
"visibility": "public"
}
]

APIForbiddenError is a forbidden error response

Media typeapplication/json
message
string
url
string

APIValidationError is error format response related to input validation

Media typeapplication/json
message
string
url
string