Search users

get

https://{host}/platform/security/v1/users

Query Params

offset

integer

Defaults to 0

Number of page displaying the returned records, starting 0

limit

integer

Defaults to 100

Number of records returned per page. See Response Pagination.

sort

string

Comma-delimited list of properties. Sort order defined by one of ASC (ascending) or DESC (descending).

include

array of strings

List of subnodes to include in response. One or more of groups or userDetails.

If groups, response returns list of user groups assigned to principal.
If userDetails, response returns userDetails object that includes email, groupCount, userCreated, userLastModified, givenName and familyName properties.

include

Allowed:

userStatus

string

enum

Status of user (principal).

Possible status depends on type of user: Api or EndUser.

Allowed:

groupId

string

ID of user group.

type

string

enum

Type of the user. One of Api or EndUser

Allowed:

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

200Success