Get users Returns a stream of users, filtered according to query parameters
GET {{baseUrl}}/:realm/users?briefRepresentation=true&email=consequat incididunt dolor pariatur&emailVerified=true&enabled=true&exact=true&first=18909540&firstName=consequat incididunt dolor pariatur&idpAlias=consequat incididunt dolor pariatur&idpUserId=consequat incididunt dolor pariatur&lastName=consequat incididunt dolor pariatur&max=18909540&search=consequat incididunt dolor pariatur&username=consequat incididunt dolor pariatur
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
briefRepresentation | boolean | Boolean which defines whether brief representations are returned (default: false) | |
email | string | A String contained in email, or the complete email, if param "exact" is true | |
emailVerified | boolean | whether the email has been verified | |
enabled | boolean | Boolean representing if user is enabled or not | |
exact | boolean | Boolean which defines whether the params "last", "first", "email" and "username" must match exactly | |
first | number | Pagination offset | |
firstName | string | A String contained in firstName, or the complete firstName, if param "exact" is true | |
idpAlias | string | The alias of an Identity Provider linked to the user | |
idpUserId | string | The userId at an Identity Provider linked to the user | |
lastName | string | A String contained in lastName, or the complete lastName, if param "exact" is true | |
max | number | Maximum results size (defaults to 100) | |
search | string | A String contained in username, first or last name, or email | |
username | string | A String contained in username, or the complete username, if param "exact" is true |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"ullamcob":"id irure quis"},{"voluptatec4":true,"eu7":-48970769}]