user

get all users

This can only be done by a logged in user who has the required privileges.

get/api/v1/users

Query parameters

metaboolean

Set to true to receive response in data/meta format

Response

List all users

idstring

User Id

usernamestring required

Username as an email address

firstnamestring required

firstname

lastnamestring required

lastname

status'ACTIVE' | 'PENDING' | 'DISABLED'
tenantstring
permissionsPermissions[]
confirmedboolean

true, if the confirmation link/email has been triggered

imgstring

url to user image

Changes

Changed in 9 of the 19 revisions of this API.715

  • 1134b4a506a533See the full diff
    • added the new ACTIVE enum value to the items/status response property for the response status 200

      response-property-enum-value-added

    • added the new DISABLED enum value to the items/status response property for the response status 200

      response-property-enum-value-added

    • added the new PENDING enum value to the items/status response property for the response status 200

      response-property-enum-value-added

    • removed the active enum value from the items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the disabled enum value from the items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the pending enum value from the items/status response property for the response status 200

      response-property-enum-value-removed

    • api operation id getUser removed and replaced with getUsers

      api-operation-id-removed

    • added the optional property items/roles/items/description to the response with the 200 status

      response-optional-property-added

    • added the optional property items/roles/items/isGlobal to the response with the 200 status

      response-optional-property-added

    • removed the optional property items/roles/items/isCreated from the response with the 200 status

      response-optional-property-removed

    • removed the optional property items/roles/items/isUpdated from the response with the 200 status

      response-optional-property-removed

    • added the optional property items/roles/items/createdAt to the response with the 200 status

      response-optional-property-added

    • added the optional property items/roles/items/updatedAt to the response with the 200 status

      response-optional-property-added

    • added the optional property items/roles/items/id to the response with the 200 status

      response-optional-property-added

    • added the optional property items/roles/items/isCreated to the response with the 200 status

      response-optional-property-added

    • added the optional property items/roles/items/isUpdated to the response with the 200 status

      response-optional-property-added

    • removed the optional property items/roles/items/description from the response with the 200 status

      response-optional-property-removed

    • added the optional property items/roles/items/scope to the response with the 200 status

      response-optional-property-added

    • removed the optional property items/roles/items/scope from the response with the 200 status

      response-optional-property-removed

    • added the optional property items/roles/items/description to the response with the 200 status

      response-optional-property-added

    • added the new optional query request parameter meta

      new-optional-request-parameter

    • endpoint added

      endpoint-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog