Skip to content

Users

Hantera användaråtkomst i Amili-systemet. Users är associerade med Accounts och kan beviljas åtkomst till alla Creditors inom det Account:et med access group account_admin. Users kan också beviljas mer specifik åtkomst till individuella Creditors genom andra access groups.

User endpoints

Se Account för att hantera affärsentiteter som users tillhör. Se swagger Application för lista över tillgängliga applikationer. Se swagger Access-Group för dokumentation och hantering av access groups.

Exempel Request

Nedan är ett exempel på att skapa en ny user. Andra operationer följer liknande request/response-mönster med samma datastruktur.

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"
}

Parametrar

Request Body Properties

PropertyTypObligatoriskBeskrivning
accountstringJaAccount ID
namestringJaAnvändarens fullständiga namn
oauth_typestringNejOAuth-autentiseringstyp (t.ex. "microsoft")*
email_oauthstringNejOAuth-e-postadress
data_accessarrayNejLista över access group-tilldelningar
is_enabledbooleanNejOm användaren är aktiv (standard: true)
applicationsarrayNejLista över applikationstilldelningar
log_invoice_registrationsbooleanNejLogga invoice registrations (standard: false)
log_case_registrationsbooleanNejLogga case registrations (standard: false)
log_creditor_paymentsbooleanNejLogga creditor payments (standard: false)
log_creditor_cancellationsbooleanNejLogga creditor cancellations (standard: false)
log_creditor_creditingsbooleanNejLogga creditor creditings (standard: false)
system_userbooleanNejOm systemanvändare (standard: false)

Data Access Properties

PropertyTypObligatoriskBeskrivning
access_groupstringJaAccess group ID**
granted_datestringNejÅtkomstbeviljandedatum
access_group_namestringNejAccess group-namn
access_group_account_namestringNejAssocierat account-namn
access_group_creditor_namestringNejAssocierat creditor-namn
access_group_typestringNejAccess group-typ (t.ex. "admin")*

Application Properties

PropertyTypObligatoriskBeskrivning
applicationstringJaApplikations-ID***
application_namestringNejApplikationsnamn (t.ex. "ada_ui")*

Response Properties

PropertyTypObligatoriskBeskrivning
_idstringJaUnik identifierare för user
_createdstringJaSkapandetidsstämpel
_updatedstringJaSenaste uppdateringstidsstämpel
_etagstringJaEntity tag för samtidighetskontroll
_statusstringJaRequest-status (t.ex. "OK")*

*) För komplett lista över värden och detaljer, se User
**) För tillgängliga access groups och detaljer, se Access Group
***) För tillgängliga applikationer och detaljer, se Application