List users

get

Authorizations

defguard_sessionstringRequired

Query parameters

pageinteger · int32Optional

Page number. Defaults to 1.

per_pageinteger · int32Optional

Number of items per page, from 1 to 100. Defaults to 50.

groupsstring[]Optional

Filter by group names. Returns users belonging to any of the given groups.

no_groupbooleanOptional

Filter users with no group membership. Combined with groups, returns users in the given groups and users with no group.

searchstringOptional

Free-text search across username, first name, last name, and email.

sort_bystring · enumOptional

Sort key: name, username, or email. Defaults to name.

Possible values:

sort_orderstring · enumOptional

Sort direction: asc or desc. Defaults to asc.

Possible values:

Responses

200

Paginated list of users.

application/json

Envelope returned by paginated endpoints.

401

Session is missing or invalid.

application/json

403

Requires admin privileges.

application/json

500

Unable to list users.

application/json

get/api/v1/user

GET /api/v1/user HTTP/1.1
Accept: */*

{
  "data": [
    {
      "authorized_apps": [],
      "devices": [],
      "email": "[e-mail]",
      "email_mfa_enabled": false,
      "enrolled": true,
      "first_name": "Jane",
      "groups": [
        "admin"
      ],
      "id": 1,
      "is_active": true,
      "is_admin": true,
      "last_name": "Doe",
      "ldap_pass_requires_change": false,
      "mfa_enabled": false,
      "mfa_method": "None",
      "name": "Jane Doe",
      "phone": null,
      "totp_enabled": false,
      "username": "jane"
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": null,
    "page_size": 50,
    "total_items": 1,
    "total_pages": 1
  }
}