# List users

Endpoint: GET /v1/domains/{domainId}/users
Security: httpAuth

## Security:

  - `httpAuth` (unknown)
    http bearer

## Path parameters:

  - `domainId` (string, required)
    Unique identifier for the domain.

## Query parameters:

  - `limit` (integer)
    The number of entities to return.

  - `startingAfter` (string)
    Entity id used to the determine beginning of query results.

  - `sortBy` (string)
    Property name used to sort the query results.

  - `sortOrder` (string)
    Sort order applied to the query results.

  - `alias` (string)
    Return entities matching given alias.

  - `publicKey` (string)
    Return entities matching given public key. It should be provided in Base64 format.

  - `roles` (array)
    Return entities that are assigned to roles.

  - `roles[]` (array)
    Return entities that are assigned to at least all the roles provided in the array.

  - `lock` (array)
    Return entities matching given lock status.

  - `metadata.createdBy` (string)
    Return entities that were created by matching user.

  - `metadata.lastModifiedBy` (string)
    Return entities that were last modified by matching user.

  - `metadata.description` (string)
    Return entities with descriptions that contains or equals to provided description.

  - `metadata.customProperties` (array)
    Return entities that contains provided custom properties.

## Response 200 fields (application/json):

  - `items` (array, required)

  - `items.data` (object, required)

  - `items.data.id` (string, required)

  - `items.data.domainId` (string, required)

  - `items.data.alias` (string, required)

  - `items.data.publicKey` (string, required)

  - `items.data.roles` (array, required)

  - `items.data.lock` (string, required)
    Enum: "Unlocked", "Locked", "Archived"

  - `items.data.metadata` (object, required)

  - `items.data.metadata.description` (string)

  - `items.data.metadata.revision` (integer, required)

  - `items.data.metadata.createdAt` (string, required)

  - `items.data.metadata.createdBy` (object)

  - `items.data.metadata.createdBy.id` (string, required)

  - `items.data.metadata.createdBy.domainId` (string, required)

  - `items.data.metadata.lastModifiedAt` (string, required)

  - `items.data.metadata.customProperties` (object, required)

  - `items.data.loginIds` (array)
    Domain-unique `loginId`-`loginProviderId` pairs.

  - `items.data.loginIds.id` (string, required)
    User name. For internal login, set to the user alias. For external identity providers, must match the external provider user name.

  - `items.data.loginIds.providerId` (string, required)
    Login provider. For internal login, set to `harmonize`. For external identity providers, must match the provider name.

  - `items.signature` (string, required)

  - `count` (integer, required)

  - `currentStartingAfter` (string)

  - `nextStartingAfter` (string)

## Response 400:

  - `400` (unknown)
    Invalid value for: path parameter domainId, Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameter alias, Invalid value for: query parameter publicKey, Invalid value for: query parameter roles, Invalid value for: query parameter roles[], Invalid value for: query parameter lock, Invalid value for: query parameter metadata.createdBy, Invalid value for: query parameter metadata.lastModifiedBy, Invalid value for: query parameter metadata.description, Invalid value for: query parameter metadata.customProperties

## Response 401:

  - `401` (unknown)
    One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)

## Response 401 fields (application/json):

  - `reason` (string, required)

  - `message` (string)

## Response 404:

  - `404` (unknown)
    Entity or Domain not found (EntityNotFoundError)

## Response 404 fields (application/json):

  - `reason` (string, required)

  - `message` (string)