Search users

get

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

Returns a list of principals.

This operation returns information about both user accounts and client applications. The optional type parameter enables filtering by type: Api or EndUser.

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

userStatus

string

enum

Status of user.

Allowed:

groupId

string

ID of user group.

type

string

enum

Type of the user. One of Api or EndUser

Allowed:

Responses

Language

Credentials

URL

Request

Response

Choose an example:

application/json

200Success

400Bad Request: Please validate the request against specifications

401Unauthorized: API key or Bearer token is missing or invalid

404Not Found: Resource not found

429Too many consecutive requests. Your request has been throttled.

500Internal server error