Users

Hantera användaråtkomst i Amili-systemet. Användare är associerade med Konton och kan beviljas åtkomst till alla Borgenärer inom det Kontot genom att använda åtkomstgruppen account_admin. Användare kan också beviljas mer specifik åtkomst till enskilda Borgenärer genom andra åtkomstgrupper.

User endpoints

• GET /users - Lista alla användare (paginerad)
• GET /users/{userId} - Hämta en specifik användare
• POST /users - Skapa en ny användare

Se Account för hantering av de affärsenheter som användare tillhör. Se swagger Application för lista över tillgängliga applikationer. Se swagger Access-Group för dokumentation och hantering av åtkomstgrupper.

Authentication Method

Den rekommenderade autentiseringsmetoden för användare är OAuth-autentisering (Microsoft, Google, etc.):

• email_oauth (string, required) - OAuth e-postadress
• oauth_type (string, required) - OAuth-leverantörstyp (t.ex. "microsoft", "google")*
• oauth_subscriber (string, optional) - OAuth-prenumerant-ID för multi-tenant-scenarier

Example Request

Nedan är ett exempel på att skapa en användare med OAuth-autentisering. 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:

{
  "account": "674dbeaf08847b9501cc9132",
  "name": "Jane Doe",
  "email_data": {
    "email": "jane.doe@domain.se"
  },
  "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

Note: One of account, partner, or solicitor is required.

Property	Type	Required	Description
account	string	Yes (or partner/solicitor)	Konto-ID - för kontoanvändare
partner	string	Yes (or account/solicitor)	Partner-ID - för partneranvändare
solicitor	object	Yes (or account/partner)	Inkassodetaljer - för inkassoanvändare (se Solicitor Properties nedan)
name	string	Yes	Användarens fullständiga namn
description	string	No	Användarbeskrivning
email_data	object	No	E-postinformation (se Email Data Properties nedan)
mobile_number_data	object	No	Mobilnummerinformation (se Mobile Number Data Properties nedan)
oauth_type	string	Yes (for OAuth)	OAuth-autentiseringstyp (t.ex. "microsoft", "google")*
email_oauth	string	Yes (for OAuth)	OAuth e-postadress
oauth_subscriber	string	No	OAuth-prenumerant-ID (kräver oauth_type och email_oauth)
data_access	array	No	Lista över åtkomstgruppstilldelningar
is_enabled	boolean	No	Om användaren är aktiv (standard: true)
applications	array	No	Lista över applikationstilldelningar
log_invoice_registrations	boolean	No	Logga fakturaregistreringar (standard: false)
log_case_registrations	boolean	No	Logga ärenderegistreringar (standard: false)
log_creditor_payments	boolean	No	Logga borgenärsbetalningar (standard: false)
log_creditor_cancellations	boolean	No	Logga borgenärsavbokningar (standard: false)
log_creditor_creditings	boolean	No	Logga borgenärskrediteringar (standard: false)
system_user	boolean	No	Om systemanvändare (standard: false)
managed_by_external_system	boolean	No	Om användaren hanteras av externt system (standard: false)
external_id	string	No	Extern systemidentifierare
main_unit	string	No	Referens till användarenhet (ObjectId)
ui_structures	array	No	UI-strukturreferenser (lista över objekt med ui_structure)
manager	string	No	Referens till chefsanvändare (ObjectId)

Email Data Properties

Property	Type	Required	Description
email	string	Yes	E-postadress

Mobile Number Data Properties

Property	Type	Required	Description
mobile_number	string	Yes	Mobilnummer

Solicitor Properties

Property	Type	Required	Description
office	string	Yes	Inkassokontor-ID (ObjectId)
function	string	No	Inkassofunktion*
external_consult	boolean	No	Om extern konsult (standard: false)
position	string	No	Befattningstitel
team	string	No	Team-ID (ObjectId)

Data Access Properties

Data access-poster kan inkludera temporala begränsningar med hjälp av fälten from och until.

Property	Type	Required	Description
access_group	string	Yes	Åtkomstgrupp-ID**
from	string	No	Datum från vilket åtkomst är giltig (RFC 1123-format)
until	string	No	Datum till vilket åtkomst är giltig (RFC 1123-format)
granted_date	string	No	Datum för åtkomstbeviljande (readonly, kaskaduppdaterad)
access_group_name	string	No	Åtkomstgruppsnamn (readonly, kaskaduppdaterad)
access_group_account_name	string	No	Associerat kontonamn (readonly, kaskaduppdaterad)
access_group_creditor_name	string	No	Associerat borgenärsnamn (readonly, kaskaduppdaterad)
access_group_partner_name	string	No	Associerat partnernamn (readonly, kaskaduppdaterad)
access_group_type	string	No	Åtkomstgruppstyp (t.ex. "admin")* (readonly, kaskaduppdaterad)

Application Properties

Property	Type	Required	Description
application	string	Yes	Applikations-ID***
application_name	string	No	Applikationsnamn (t.ex. "ada_ui")*

Response Properties

Property	Type	Required	Description
_id	string	Yes	Unik identifierare för användaren
_created	string	Yes	Tidsst\u00e4mpel för skapande
_updated	string	Yes	Tidsst\u00e4mpel för senaste uppdatering
_etag	string	Yes	Entity tag för samtidighetskontroll
_status	string	Yes	Request-status (t.ex. "OK")*

Validation Rules

User Type Requirement:

• En av account, partner, eller solicitor är obligatorisk (any_of_required)
• Dessa fält är ömsesidigt uteslutande - tillhandahåll endast ett

OAuth Authentication:

• oauth_type och email_oauth är obligatoriska för OAuth-autentisering
• oauth_subscriber är valfri och kräver att både oauth_type och email_oauth är satta

Unikhetsbegränsningar: Följande nyckelpar måste vara unika:

• (partner, name, email_oauth) - för partneranvändare med OAuth
• (account, name, email_oauth) - för kontoanvändare med OAuth

Data Access Temporal Restrictions:

• Fälten from och until i data_access-poster tillåter tidsbegränsad åtkomst
• Båda fälten använder RFC 1123 datetime-format
• Åtkomst är giltig från from-datum (inklusivt) till until-datum (exklusivt)

Cascade Updates: Flera fält i data_access uppdateras automatiskt när relaterade dokument ändras:

• granted_date - Sätts när åtkomst beviljas
• access_group_name - Uppdateras från access_group.name
• access_group_account_name - Uppdateras från access_group.account.name
• access_group_creditor_name - Uppdateras från access_group.creditor.name
• access_group_partner_name - Uppdateras från access_group.partner.name
• access_group_type - Uppdateras från access_group.type

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