![Full Logo — white_gradientNEW-1.png]](https://help.inqom.com/hs-fs/hubfs/Full%20Logo%20%E2%80%94%20white_gradientNEW-1.png?height=40&name=Full%20Logo%20%E2%80%94%20white_gradientNEW-1.png){kind=small}
Gestion des comptes utilisateurs cabinet par API (provisionning)
Comment gérer par API les collaborateurs d'un cabinet : création, assignation aux dossiers, listing et désassignation.
1) Les différents rôles possibles
|
CodeRole |
Rôle |
Accès |
|---|---|---|
|
CA |
Expert-comptable |
Accès complet à toutes les fonctionnalités et à l'administration du cabinet. Doit impérativement être assigné au dossier pour pouvoir faire une action de provision dessus. |
|
A |
Chef de mission comptable |
Accès à toutes les actions comptables mais pas à l'administration du cabinet. Doit impérativement être assigné au dossier pour pouvoir faire une action de provision dessus. |
|
S |
Chef de mission social |
Accès principalement à la consultation des pièces et à la GED. Pas d'accès à la comptabilité. |
|
SYSTEM |
Compte de service |
Plus haut niveau de droit, sert aux intégrations API. N'a pas à être assigné au dossier pour faire des actions de provision dessus. Ne peut pas être supprimé en front. Sollicitez-nous pour la création de ces comptes, ils ne peut pas être créer en autonomie. |
2) Création de comptes
POST https://api.inqom.com/provisioning/companies/{companyId}/users
companyId est décrite dans cet article.{
"Gender": "Ms",
"Firstname": "Prénom",
"Lastname": "Nom",
"Email": "prenom.nom@cabinet.com",
"CodeRole": "CA",
"Active": true,
"ShouldSendEmail": true
}
Description des champs :
|
Champ |
Obligatoire |
Description |
|---|---|---|
|
Gender |
Oui |
Civilité : Mrs (Madame), Mr (Monsieur), Ms (Madame, non mariée). |
|
Firstname |
Non |
Prénom du collaborateur. |
|
Lastname |
Non |
Nom du collaborateur. |
|
|
Non |
Adresse mail qui servira d'identifiant de connexion. |
|
CodeRole |
Oui |
Rôle cabinet : CA (Expert-comptable), A (Chef de mission), S (Chef de mission social). |
|
Active |
Oui |
true = compte actif immédiatement. |
|
ShouldSendEmail |
Non |
true = envoie l'email d'invitation. false = aucun email envoyé (en cas de SSO). Défaut : true. Attention : si pas d'envoi de mail, l'utilisateur ne pourra pas définir son mot de passe. |
{
"Id": 12345, // <-- userId à stocker pour les actions à suivre
"CabinetId": 1,
"Gender": "Ms",
"Firstname": "Prenom",
"Lastname": "Nom",
"Email": prenom.nom@cabinet.com,
"CodeRole": "CA"
}
Si vous travaillez avec Azure AD, parlez-en à votre contact Inqom et consultez notre méthode de provisionning SCIM.
3) Assignation/désassignation
A) Assigner un collaborateur à un ou plusieurs dossiers comptables
POST https://api.inqom.com/companies/{companyId}/accounting-folders/assign
cf. documentation technique. La méthode de récupération du companyId et des accountingFoldersId est décrite dans cet article. Le UserId aura été récupéré lors de la création du compte (cf. étape précédente) ou en listant les utilisateurs sur ce dossier .
Avec body (exemple) :
{
"UserId": 12345,
"AccountingFoldersId": [
00001,00002,00003
]
}
B) Désassigner d'un cabinet
Désassigne le collaborateur d'un cabinet. Cette action désassigne également l'utilisateur de tous les dossiers du cabinet.
POST https://api.inqom.com/provisioning/companies/{companyId}/unassign
Avec body (exemple) :
{
"UserId": 12345
}
cf. documentation technique. La méthode de récupération des companyId est décrite dans cet article. Le UserId aura été récupéré lors de la création du compte (cf. étape précédente) ou en listant les utilisateurs sur ce cabinet .
C) Désassigner d'un dossier spécifique
POST https://api.inqom.com/provisioning/companies/{companyId}/accounting-folders/unassign
Avec body (exemple) :
{
"UserId": 12345,
"AccountingFolderId": 00001
}
cf. documentation technique. La méthode de récupération du companyId et du accountingFolderId est décrite dans cet article. Le UserId aura été récupéré lors de la création du compte (cf. étape précédente) ou en listant les utilisateurs sur ce dossier .
4) Lister les utilisateurs
A) Lister les comptes d'un cabinet
Retourne tous les utilisateurs rattachés au cabinet, avec leurs rôles et statuts d'activation.
GET https://api.inqom.com/api/app/companies/{companyId}/users-list
cf. documentation technique. La méthode de récupération du companyId est décrite dans cet article.
Exemple de réponse :
[
{
"Id": 12345,
"Gender": "Mr",
"FirstName": "Prénom",
"LastName": "Nom",
"Email": "prenom.nom@cabinet.com",
"PhoneNumber": "0601020304",
"AvatarUrl": "string",
"Role": {
"Name": "string",
"Description": "string",
"Id": 3,
"Code": "CA",
"Label": "Expert-comptable",
"Type": "Accounting"
},
"IsActivated": true,
"PersonalFolderId": 0
}
]
B) Lister les comptes d'un dossier
Retourne les utilisateurs (collaborateurs et clients) assignés à un dossier. Très utile pour vérifier les assignations et les rôles par dossier.
GET https://api.inqom.com/provisioning/companies/{companyId}/accounting-folders/{accountingFolderId}/users
cf. documentation technique. La méthode de récupération du companyId et du accountingFolderId est décrite dans cet article.