Skip to main content

​
List Users

List all users for an instance with pagination, filtering, and sorting. Endpoint: GET /instances/:instanceId/users Query Parameters:
  • username (string, optional) - Filter by username
  • enabled (boolean, optional) - Filter by enabled status
  • page (number, optional) - Page number (0-based)
  • size (number, optional) - Page size
  • sort (string, optional) - Sort field and direction (e.g., “updatedAt,desc”)
Response: Paginated response with user list Source: Feature Inventory - API Surface (Users API)

​
Get User

Get a single user by ID. Endpoint: GET /instances/:instanceId/users/:userId Response: User object Source: Feature Inventory - API Surface (Users API)

​
Create User

Create a new user. Endpoint: POST /instances/:instanceId/users Request Body: 
{
  "username": "jdoe",
  "email": "jdoe@example.com",
  "name": "John",
  "middleName": "A",
  "familyName": "Doe",
  "temporaryPassword": "TempPass123!"
}
Fields:
  • username (string, required) - Username
  • email (string, required) - Email address
  • name (string, required) - First name
  • middleName (string, optional) - Middle name
  • familyName (string, optional) - Family name
  • temporaryPassword (string, required) - Initial password
Response: Created user object Source: Feature Inventory - API Surface (Users API)

​
Update User

Update an existing user. Endpoint: PUT /instances/:instanceId/users/:userId Request Body: 
{
  "username": "jdoe",
  "email": "jdoe@example.com",
  "name": "John",
  "middleName": "A",
  "familyName": "Doe",
  "enabled": true,
  "temporaryPassword": "NewTempPass123!"
}
Fields:
  • All fields from Create User (all optional)
  • enabled (boolean, optional) - Whether user is enabled
  • temporaryPassword (string, optional) - Only include if changing password
Response: Updated user object Source: Feature Inventory - API Surface (Users API)