PApassbolt
Users

Get multiple users.

Changed on
get/users.json

Request

Query parameters

contain[last_logged_in]1 | 0

Add last logged in to response body.

contain[groups_users]1 | 0

Add group users to groups in response body.

contain[gpgkey]1 | 0

Add GPG key data to response body.

contain[profile]1 | 0

Add profile to response body.

contain[role]1 | 0

Add role to response body.

contain[missing_metadata_key_ids]1 | 0

Add missing metadata key IDs to response body.

filter[search]string

Filter using a keyword or a string.

filter[has-groups]string[]

Only return elements filtered by groups.

filter[has-access]string[]

Only return elements where specified users have access.

filter[is-admin]boolean

Only return admin users.

filter[is-active]boolean

Only return active elements.

Response

Operation is successful

Example response

{
  "header": {
    "servertime": 1720702619,
    "message": "The operation was successful.",
    "url": "/auth/verify.json",
    "code": 200
  }
}

Changes

  • 829cf48ab700Revision changes
    • info

      added the new optional query request parameter contain[missing_metadata_key_ids]

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status