Skip to navigation

List users

This endpoint returns a list of users

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

limitlongOptional
offsetlongOptional
idslist of stringsOptional
externalUserIdslist of stringsOptional
emailslist of stringsOptional
querystringOptional
publicKeystringOptional
excludeTechnicalUsersbooleanOptional
roleslist of stringsOptional
If roles are provided, only users having all the given roles will be returned.
statusstringOptional
totpEnabledbooleanOptional
groupIdslist of stringsOptional

Response

A successful response.
resultlist of objectsOptional
totalItemsstringOptionalformat: "uint64"

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error