Get user list.

get

https://api.test.bluestonepim.com/keycloak-mgmt-v3/users

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

query

string

Search users by username, name, email and mobile.

username

string

Return a user by username. Other user info filters will be ignored.

name

string

Return only users that contain the given name.

number

string

Return only users that contain the given number.

string

Return only users that contain the given email.

mobile

string

Return only users that contain the given mobile.

roleId

string

Role Id.

profileId

string

Return only users under the profile id.

includePermission

boolean

Defaults to false

Include permission in the response.

permissionType

string

enum

Get only permissions that are the given type.

Allowed:

userStatus

string

enum

User status.

Allowed:

sort

string

Sort result by the given sort field and direction in format: 'sort:direction'. Sort{firstname,lastname,email}. Direction{asc,desc}. Support multiple sort fields using comma separated (example: ?sort=email:desc,firstname:asc).

page

int32

Defaults to 0

pageSize

int32

≥ 1

Defaults to 10

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200User described

400Bad request