API Dokumentation

List all users' info

get
https://{server}/api/v2.1/admin/users/

Return a paginated list of users from the database (default) or of LDAP-imported users.

  • Filter by is_active and role (only effective for source=DB).
  • Sort by quota_usage with order_by (not offered if there are more than 500 users). Sorted results contain a reduced field set (no avatar_url, no social_auth).
  • Since v13 every user contains social_auth, the list of linked external identities (SSO/LDAP).

Permission: System admin (is_staff) whose admin role grants can_manage_user. Admin roles with a restricted permission set (e.g. audit_admin, system_admin) receive 403.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
Defaults to 1
integer
Defaults to 25

Number of users per page.

string
enum
Defaults to DB

User source (case-insensitive). LDAPImport lists users linked to the (multi-)LDAP provider.

Allowed:
string
enum

Sort field.

Allowed:
string
enum
Defaults to desc

Sort direction, only used with order_by.

Allowed:
string
enum

1 = only active users, 0 = only inactive users.

Allowed:
string

Only return users with this role, e.g. default or guest.

Responses

400

source, order_by or direction invalid, or sorting not offered (more than 500 users).

403

Permission denied: the account is not a system admin, or its admin role lacks the required admin permission.

500

Internal server error.

Updated 22 days ago

Did this page help you?
Language
Credentials
Bearer
Account-Token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 22 days ago

Did this page help you?