Skip to content

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

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/json

Request Body:

json
{
  "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:

json
{
  "_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

PropertyTypeRequiredDescription
accountstringYesAccount ID
namestringYesUser's full name
oauth_typestringNoOAuth authentication type (e.g. "microsoft")*
email_oauthstringNoOAuth email address
data_accessarrayNoList of access group assignments
is_enabledbooleanNoWhether user is active (default: true)
applicationsarrayNoList of application assignments
log_invoice_registrationsbooleanNoLog invoice registrations (default: false)
log_case_registrationsbooleanNoLog case registrations (default: false)
log_creditor_paymentsbooleanNoLog creditor payments (default: false)
log_creditor_cancellationsbooleanNoLog creditor cancellations (default: false)
log_creditor_creditingsbooleanNoLog creditor creditings (default: false)
system_userbooleanNoWhether system user (default: false)

Data Access Properties

PropertyTypeRequiredDescription
access_groupstringYesAccess group ID**
granted_datestringNoAccess grant date
access_group_namestringNoAccess group name
access_group_account_namestringNoAssociated account name
access_group_creditor_namestringNoAssociated creditor name
access_group_typestringNoAccess group type (e.g. "admin")*

Application Properties

PropertyTypeRequiredDescription
applicationstringYesApplication ID***
application_namestringNoApplication name (e.g. "ada_ui")*

Response Properties

PropertyTypeRequiredDescription
_idstringYesUnique identifier for the user
_createdstringYesCreation timestamp
_updatedstringYesLast update timestamp
_etagstringYesEntity tag for concurrency control
_statusstringYesRequest 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