Path: / admin / realms / {realm} / users

Query list of users. May pass in query criteria

Path parameters:
realm - realm name (not id!)

Sub-Resources
Resources
NameDescription
{username}Get represenation of the user

Resource Methods
Method Summary
NameDescription
POST /admin/realms/{realm}/usersCreate a new user.
GET /admin/realms/{realm}/users?search=…&lastName=…&firstName=…&email=…&username=…&first=…&max=…Query list of users.

Method Detail

POST /admin/realms/{realm}/users

Create a new user. Must be a unique username!

HTTP Example:
POST /admin/realms/{realm}/users
API Example:

UsersResource.createUser({'realm': /* name realm name (not id!) */,
  '$entity': /* rep */});

Input:
UserRepresentation
Output:
Response -
Consumes:
application/json

GET /admin/realms/{realm}/users

Query list of users. May pass in query criteria

HTTP Example:
GET /admin/realms/{realm}/users?search=…&lastName=…&firstName=…&email=…&username=…&first=…&max=…
API Example:

UsersResource.getUsers({'search': /* search string contained in username, first or last name, or email */,
  'lastName': /* last */,
  'firstName': /* first */,
  'email': /* email */,
  'username': /* username */,
  'first': /* Query list of users. */,
  'max': /* Query list of users. */,
  'realm': /* name realm name (not id!) */});

Output:
List<UserRepresentation> -
Query parameters:
search - string contained in username, first or last name, or email
lastName
firstName
email
username
first
max
Produces:
application/json