Examples

GET /api/users
200
{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "firstname": "One",
      "lastname": "User",
      "mail": "userone@someware.com",
      "admin": false,
      "auth_source_id": 980190962,
      "auth_source_name": "ldap-server",
      "timezone": null,
      "locale": null,
      "last_login_on": "2009-10-12 21:50:04 UTC",
      "created_at": "2019-02-20 13:25:27 UTC",
      "updated_at": "2019-02-20 13:25:27 UTC",
      "id": 980190962,
      "login": "one",
      "description": null,
      "ssh_keys": [],
      "default_location": null,
      "locations": [
        {
          "id": 255093256,
          "name": "Location 1"
        }
      ],
      "default_organization": null,
      "organizations": [
        {
          "id": 447626438,
          "name": "Organization 1"
        }
      ],
      "effective_admin": false
    },
    {
      "firstname": "Scoped",
      "lastname": "User",
      "mail": "userscoped@someware.com",
      "admin": false,
      "auth_source_id": 980190962,
      "auth_source_name": "ldap-server",
      "timezone": null,
      "locale": null,
      "last_login_on": "2009-10-12 21:50:05 UTC",
      "created_at": "2019-02-20 13:25:27 UTC",
      "updated_at": "2019-02-20 13:25:27 UTC",
      "id": 117925625,
      "login": "scoped",
      "description": null,
      "ssh_keys": [],
      "default_location": null,
      "locations": [
        {
          "id": 255093256,
          "name": "Location 1"
        }
      ],
      "default_organization": null,
      "organizations": [
        {
          "id": 447626438,
          "name": "Organization 1"
        }
      ],
      "effective_admin": false
    }
  ]
}

Params

Param name Description
auth_source_ldap_id
optional

ID of LDAP authentication source

Validations:

  • Must be a String

usergroup_id
optional

ID of user group

Validations:

  • Must be a String

role_id
optional

ID of role

Validations:

  • Must be a String

location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

search
optional

filter results

Validations:

  • Must be a String

order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
optional

paginate results

Validations:

  • Must be a String

per_page
optional

number of entries per request

Validations:

  • Must be a String

Search fields

Field name Type Possible values
admin true, false
description text
firstname string
last_login_on datetime
lastname string
location string
location_id integer
login string
mail string
organization string
organization_id integer
role string
role_id integer
usergroup string