Get Users
GET/api/users
Find all users with the specified filters.
You can find more information about user management here.
Filter:
email: The email of a user; must be an exact match.roles: A set of roles the users should have.groups: A set of groups the users should be a member of.identities: A set of identity providers the users should be connected to.createdAtAfter: A date the users should be created after.createdAtBefore: A date the users should be created before.lastActiveAfter: A date the users should be last active after.lastActiveBefore: A date the users should be last active before.
Tokens
- A valid
AccessTokenwithADMINpermissions is required.
Request
Responses
- 200
- 401
- 403
- 500
The users.
The following error codes correspond to this status:
ACCESS_TOKEN_EXPIRED: Indicates that the access token is expired.ACCESS_TOKEN_INVALID: Indicates that the access token cannot be decoded.AUTHENTICATION_REQUIRED: User is not authenticated.
The following error codes correspond to this status:
ROLE_REQUIRED: Principal does not have required role.
The following error codes correspond to this status:
ACCESS_TOKEN_ALLOWLIST_READING_FAILURE: Represents an exception indicating a failure when reading the allowlist for an access token cache.DATABASE_FAILURE: Exception representing a general failure related to database operations.DATABASE_ENCRYPTION_FAILURE: Exception representing a general failure related to database encryption operations.HASH_FAILURE: Exception representing a general failure related to hashing operations.INVALID_PRINCIPAL_DOCUMENT: A requested principal document was stored in an invalid format.