v1

latestOpenAPI 3.0.12026-08-061638881007.6 KB
Users

List users

get/v1/domains/{domainId}/users

Path parameters

domainIdstring uuid required

Unique identifier for the domain.

Query parameters

limitinteger

The number of entities to return.

startingAfterstring uuid

Entity id used to the determine beginning of query results.

sortBy'id' | 'alias' | 'lock' | 'metadata.createdAt' | 'metadata.lastModifiedAt'

Property name used to sort the query results.

sortOrder'ASC' | 'DESC'

Sort order applied to the query results.

aliasstring

Return entities matching given alias.

publicKeystring

Return entities matching given public key. It should be provided in Base64 format.

rolesstring[]

Return entities that are assigned to roles.

roles[ ]string[]

Return entities that are assigned to at least all the roles provided in the array.

lockCoreLockStatus[]

Return entities matching given lock status.

metadata.createdBystring uuid

Return entities that were created by matching user.

metadata.lastModifiedBystring uuid

Return entities that were last modified by matching user.

metadata.descriptionstring

Return entities with descriptions that contains or equals to provided description.

metadata.customPropertiesstring[]

Return entities that contains provided custom properties.

Response

countinteger required
currentStartingAfterstring
nextStartingAfterstring