Users
Manage user access in the Amili system. Users are associated with Accounts and can be granted access to all Creditors within that Account using the account_admin access group. Users can also be granted more specific access to individual Creditors through other access groups.
User endpoints
GET /users- List all users (paginated)GET /users/{userId}- Get a specific userPOST /users- Create a new user
See Account for managing the business entities users belong to. See swagger Application for list of available applications. See swagger Access-Group for documentation and and management of access groups.
Example Request
Below is an example of creating a new user. Other operations follow similar request/response patterns with the same data structure.
URL: POST /users
Headers:
x-api-key: {your_access_token}
Content-Type: application/jsonRequest Body:
{
"account": "674dbeaf08847b9501cc9132",
"name": "Jane Doe",
"oauth_type": "microsoft",
"email_oauth": "jane.doe@domain.se",
"data_access": [
{
"access_group": "60e7fdefc90dc3e2ddd6c7ad"
}
],
"is_enabled": true,
"applications": [
{
"application": "60e7fdefc90dc3e2ddd6c7af"
},
{
"application": "60e7fdefc90dc3e2ddd6c7b0"
}
]
}Response Code: 201 Created
Response Body:
{
"_updated": "Fri, 29 Aug 2025 07:45:25 GMT",
"_created": "Fri, 29 Aug 2025 07:45:25 GMT",
"_etag": "8be4d5fc86d77d226b0f83f8593de42334a0a192",
"_id": "68678ed98d8dc95ece127944",
"_status": "OK"
}Parameters
Request Body Properties
| Property | Type | Required | Description |
|---|---|---|---|
account | string | Yes | Account ID |
name | string | Yes | User's full name |
oauth_type | string | No | OAuth authentication type (e.g. "microsoft")* |
email_oauth | string | No | OAuth email address |
data_access | array | No | List of access group assignments |
is_enabled | boolean | No | Whether user is active (default: true) |
applications | array | No | List of application assignments |
log_invoice_registrations | boolean | No | Log invoice registrations (default: false) |
log_case_registrations | boolean | No | Log case registrations (default: false) |
log_creditor_payments | boolean | No | Log creditor payments (default: false) |
log_creditor_cancellations | boolean | No | Log creditor cancellations (default: false) |
log_creditor_creditings | boolean | No | Log creditor creditings (default: false) |
system_user | boolean | No | Whether system user (default: false) |
Data Access Properties
| Property | Type | Required | Description |
|---|---|---|---|
access_group | string | Yes | Access group ID** |
granted_date | string | No | Access grant date |
access_group_name | string | No | Access group name |
access_group_account_name | string | No | Associated account name |
access_group_creditor_name | string | No | Associated creditor name |
access_group_type | string | No | Access group type (e.g. "admin")* |
Application Properties
| Property | Type | Required | Description |
|---|---|---|---|
application | string | Yes | Application ID*** |
application_name | string | No | Application name (e.g. "ada_ui")* |
Response Properties
| Property | Type | Required | Description |
|---|---|---|---|
_id | string | Yes | Unique identifier for the user |
_created | string | Yes | Creation timestamp |
_updated | string | Yes | Last update timestamp |
_etag | string | Yes | Entity tag for concurrency control |
_status | string | Yes | Request status (e.g. "OK")* |
*) For complete list of values and details, please see User
**) For available access groups and details, please see Access Group
***) For available applications and details, please see Application
