Skip to content

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 ​

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

Exempel ​

För kodexempel och detaljerade användningsguider, se Användarhantering.

För komplett API-specifikation med interaktiv testning, se Swagger: User.

Parameters ​

Request Body Properties ​

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

PropertyTypeRequiredDescription
accountstringYes (or partner/solicitor)Konto-ID - för kontoanvändare
partnerstringYes (or account/solicitor)Partner-ID - för partneranvändare
solicitorobjectYes (or account/partner)Inkassodetaljer - för inkassoanvändare (se Solicitor Properties nedan)
namestringYesAnvändarens fullständiga namn
descriptionstringNoAnvändarbeskrivning
email_dataobjectNoE-postinformation (se Email Data Properties nedan)
mobile_number_dataobjectNoMobilnummerinformation (se Mobile Number Data Properties nedan)
oauth_typestringYes (for OAuth)OAuth-autentiseringstyp (t.ex. "microsoft", "google")*
email_oauthstringYes (for OAuth)OAuth e-postadress
oauth_subscriberstringNoOAuth-prenumerant-ID (kräver oauth_type och email_oauth)
data_accessarrayNoLista över åtkomstgruppstilldelningar
is_enabledbooleanNoOm användaren är aktiv (standard: true)
applicationsarrayNoLista över applikationstilldelningar
log_invoice_registrationsbooleanNoLogga fakturaregistreringar (standard: false)
log_case_registrationsbooleanNoLogga ärenderegistreringar (standard: false)
log_creditor_paymentsbooleanNoLogga borgenärsbetalningar (standard: false)
log_creditor_cancellationsbooleanNoLogga borgenärsavbokningar (standard: false)
log_creditor_creditingsbooleanNoLogga borgenärskrediteringar (standard: false)
system_userbooleanNoOm systemanvändare (standard: false)
managed_by_external_systembooleanNoOm användaren hanteras av externt system (standard: false)
external_idstringNoExtern systemidentifierare
main_unitstringNoReferens till användarenhet (ObjectId)
ui_structuresarrayNoUI-strukturreferenser (lista över objekt med ui_structure)
managerstringNoReferens till chefsanvändare (ObjectId)

Email Data Properties ​

PropertyTypeRequiredDescription
emailstringYesE-postadress

Mobile Number Data Properties ​

PropertyTypeRequiredDescription
mobile_numberstringYesMobilnummer

Solicitor Properties ​

PropertyTypeRequiredDescription
officestringYesInkassokontor-ID (ObjectId)
functionstringNoInkassofunktion*
external_consultbooleanNoOm extern konsult (standard: false)
positionstringNoBefattningstitel
teamstringNoTeam-ID (ObjectId)

Data Access Properties ​

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

PropertyTypeRequiredDescription
access_groupstringYesÅtkomstgrupp-ID**
fromstringNoDatum från vilket åtkomst är giltig (RFC 1123-format)
untilstringNoDatum till vilket åtkomst är giltig (RFC 1123-format)
granted_datestringNoDatum för åtkomstbeviljande (readonly, kaskaduppdaterad)
access_group_namestringNoÅtkomstgruppsnamn (readonly, kaskaduppdaterad)
access_group_account_namestringNoAssocierat kontonamn (readonly, kaskaduppdaterad)
access_group_creditor_namestringNoAssocierat borgenärsnamn (readonly, kaskaduppdaterad)
access_group_partner_namestringNoAssocierat partnernamn (readonly, kaskaduppdaterad)
access_group_typestringNoÅtkomstgruppstyp (t.ex. "admin")* (readonly, kaskaduppdaterad)

Application Properties ​

PropertyTypeRequiredDescription
applicationstringYesApplikations-ID***
application_namestringNoApplikationsnamn (t.ex. "ada_ui")*

Response Properties ​

PropertyTypeRequiredDescription
_idstringYesUnik identifierare för användaren
_createdstringYesTidsst\u00e4mpel för skapande
_updatedstringYesTidsst\u00e4mpel för senaste uppdatering
_etagstringYesEntity tag för samtidighetskontroll
_statusstringYesRequest-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