Utilisateurs¶

Création d'un utilisateur¶

Route¶

POST /rest/users

Paramètres¶

Body¶

Valeur	Type	Obligatoire	Valeur par défaut	Description
userId	string	Oui		Login
firstname	string	Oui		Prénom
lastname	string	Oui		Nom
initials	string	Non		Initiales
mail	string	Oui		Email
phone	string	Non		Numéro de téléphone
mode	string	Non	"standard"	"standard" : Par défaut, "rest" : Utilisateur WebService (API), "root_invisible" : Compte super administrateur visible dans les workflows (Assignable) ou "root_visible" : Compte super administrateur non visible dans les workflows (Non Assignable)

Exemple¶

{
    "userId" : "bwayne",
    "firstname" : "Bruce",
    "lastname" : "Wayne",
    "mail" : "bruce.wayne@wcorp.com",
    "phone" : "+33120212223"
}

Retour¶

Code Http	Type	Description	Exemple
200	array	L'utilisateur a bien été créé	['id' => 21]
`400`	array	Un paramètre obligatoire est manquant	['errors' => 'Bad Request']
`403`	array	Droits insuffisants pour cette action	['errors' => 'Service forbidden']
`500`	array	Une erreur s'est produite	['errors' => '...']

Modification d'un utilisateur¶

Route¶

PUT /rest/users/{id}

Le paramètre id de la route représente l'identifiant technique (users.id) de l'utilisateur à modifier.

Paramètres¶

Body¶

Valeur	Type	Obligatoire	Valeur par défaut	Description
firstname	string	Oui		Prénom
lastname	string	Oui		Nom
initials	string	Non		Initiales
mail	string	Oui		Email
phone	string	Non		Numéro de téléphone
mode	string	Non	"standard"	"standard" : Par défaut, "rest" : Utilisateur WebService (API), "root_invisible" : Compte super administrateur visible dans les workflows (Assignable) ou "root_visible" : Compte super administrateur non visible dans les workflows (Non Assignable)

Exemple¶

{
    "firstname" : "Bruce",
    "lastname" : "Wayne",
    "mail" : "bruce.wayne@wcorp.com",
    "phone" : "+33120212223"
}

Retour¶

Code Http	Type	Description	Exemple
204	array	L'utilisateur a bien été modifié
`400`	array	Un paramètre obligatoire est manquant	['errors' => 'Bad Request']
`403`	array	Droits insuffisants pour cette action	['errors' => 'Service forbidden']
`500`	array	Une erreur s'est produite	['errors' => '...']

Ajout d'un groupe¶

Route¶

POST /rest/users/{id}/groups

Le paramètre id de la route représente l'identifiant technique (users.id) de l'utilisateur à modifier.

Paramètres¶

Body¶

Valeur	Type	Obligatoire	Valeur par défaut	Description
groupId	string	Oui		Identifiant du groupe à ajouter (usergroups.group_id)

Exemple¶

{
    "groupId" : "ELU"
}

Retour¶

Code Http	Type	Description	Exemple
200	array	La modification a bien été prise en compte
`400`	array	Un paramètre obligatoire est manquant	['errors' => 'Bad Request']
`403`	array	Droits insuffisants pour cette action	['errors' => 'Service forbidden']
`500`	array	Une erreur s'est produite	['errors' => '...']

Suppression d'un groupe¶

Route¶

DELETE /rest/users/{id}/groups/{groupId}

Le paramètre id de la route représente l'identifiant technique (users.id) de l'utilisateur à modifier.
Le paramètre groupId représente l'identifiant (usergroups.group_id) du groupe à supprimer.

Retour¶

Code Http	Type	Description	Exemple
200	array	La modification a bien été prise en compte
`400`	array	Un paramètre obligatoire est manquant	['errors' => 'Bad Request']
`403`	array	Droits insuffisants pour cette action	['errors' => 'Service forbidden']
`500`	array	Une erreur s'est produite	['errors' => '...']

Ajout d'une entité¶

Route¶

POST /rest/users/{id}/entities

Le paramètre id de la route représente l'identifiant technique (users.id) de l'utilisateur à modifier.

Paramètres¶

Body¶

Valeur	Type	Obligatoire	Valeur par défaut	Description
entityId	string	Oui		Identifiant (entities.entity_id) de l'entité à ajouter

Exemple¶

{
    "entityId" : "PJS"
}

Retour¶

Code Http	Type	Description	Exemple
200	array	La modification a bien été prise en compte
`400`	array	Un paramètre obligatoire est manquant	['errors' => 'Bad Request']
`403`	array	Droits insuffisants pour cette action	['errors' => 'Service forbidden']
`500`	array	Une erreur s'est produite	['errors' => '...']

Suppression d'une entité¶

Route¶

DELETE /rest/users/{id}/entities/{entityId}

Le paramètre id de la route représente l'identifiant technique (users.id) de l'utilisateur à modifier.
Le paramètre entityId représente l'identifiant (entities.entity_id) de l'entité à supprimer.

Retour¶

Code Http	Type	Description	Exemple
200	array	La modification a bien été prise en compte
`400`	array	Un paramètre obligatoire est manquant	['errors' => 'Bad Request']
`403`	array	Droits insuffisants pour cette action	['errors' => 'Service forbidden']
`500`	array	Une erreur s'est produite	['errors' => '...']

Ajout d'un délégataire de signature¶

Route¶

PUT /rest/users/{id}/signatorySubstitute

Le paramètre id de la route représente l'identifiant technique (users.id) de l'utilisateur à modifier.

Paramètres¶

Body¶

Valeur	Type	Obligatoire	Valeur par défaut	Description
destUser	integer	Oui		Identifiant (users.id) de l'utilisateur délégataire

Exemple¶

{
    "destUser" : 10
}

Retour¶

Code Http	Type	Description	Exemple
200	array	La modification a bien été prise en compte
`400`	array	Un paramètre obligatoire est manquant	['errors' => 'Id is empty or not an integer']
`500`	array	Une erreur s'est produite	['errors' => '...']

Suppression d'un délégataire de signature¶

Route¶

DELETE /rest/users/{id}/signatorySubstitute

Le paramètre id de la route représente l'identifiant technique (users.id) de l'utilisateur à modifier.

Paramètres¶

Body¶

Valeur	Type	Obligatoire	Valeur par défaut	Description
destUsers	array	Oui		Tableau contenant le ou les identifiant(s) (users.id) de(s) l'utilisateur(s) délégataire(s) à supprimer

Exemple¶

{
    "destUsers" : [10, 19]
}

Retour¶

Code Http	Type	Description	Exemple
204	array	La modification a bien été prise en compte
`400`	array	Un paramètre obligatoire est manquant	['errors' => 'Id is empty or not an integer']
`500`	array	Une erreur s'est produite	['errors' => '...']

Liste des utilisateurs¶

Route¶

GET /rest/users

Retour¶

Code Http	Type	Description	Exemple
200	array	liste des utilisateurs
`403`	array	Droits insuffisants pour cette action	['errors' => 'Service forbidden']
`500`	array	Une erreur s'est produite	['errors' => '...']

Exemple¶

{
  "users": [
    {
      "id": 9,
      "user_id": "bboule",
      "firstname": "Bruno",
      "lastname": "BOULE",
      "status": "OK",
      "mail": "bruno.boule@mail.org",
      "mode": "standard"
    },
    {...}
  ]
}

Description des statuts utilisateur :¶

OK : Actif
ABS : Absent
SPD : Suspendu

Liaison des comptes Maarch Courrier avec les comptes Maarch Parapheur¶

Associer un compte utilisateur Maarch Parapheur¶

Route¶

PUT /rest/users/{id}/linkToMaarchParapheur

Le paramètre id de la route représente l'identifiant technique de l'utilisateur Maarch Courrier.

Body¶

Valeur	Type	Obligatoire	Description
maarchParapheurUserId	integer	Oui	Identifiant technique de l'utilisateur Maarch Parapheur

Exemple¶

{
    "maarchParapheurUserId" : 19
}

Retour¶

Code Http	Type	Description	Exemple
`200`	json	La liaison a bien été effectuée	{sucess: "success"}
`400`	array	Message d'erreur	['errors' => 'User does not exist in Maarch Parapheur']
`403`	array	Utilisateur déjà lié	['errors' => 'This maarch parapheur user is already linked to someone. Choose another one']

Création d'un nouveau compte Maarch Parapheur¶

Il est possible de créer un nouveau compte utilisateur Maarch Parapheur et l'associer automatiquement au compte utilisateur Maarch Parapheur.

Route¶

PUT /rest/users/{id}/createInMaarchParapheur

Le paramètre id de la route représente l'identifiant technique de l'utilisateur Maarch Courrier.

Body¶

Valeur	Type	Obligatoire	Description
login	string	Oui	Identifiant technique de l'utilisateur Maarch Parapheur

Exemple¶

{
    "login" : "bbain"
}

Retour¶

Code Http	Type	Description	Exemple
`200`	array	La liaison a bien été effectuée	{externalId: 19}
`400`	array	Message d'erreur	['errors' => 'User does not exist in Maarch Parapheur']
`403`	array	Utilisateur déjà lié	['errors' => 'This maarch parapheur user is already linked to someone. Choose another one']

Exemple¶

{
  "externalId": 19 // Identifiant technique de l'utilisateur Maarch Parapheur créé
}

Dissocier un compte utilisateur Maarch Parapheur¶

Route¶

PUT /rest/users/{id}/unlinkToMaarchParapheur

Le paramètre id de la route représente l'identifiant technique de l'utilisateur Maarch Courrier.

Retour¶

Code HTTP	Type	Description	Exemple
`200`	json	La dissociation a bien été effectuée	{success: "sucess"}

Statut de l'utilisateur Maarch Courrier dans Maarch Parapheur¶

Route¶

PUT /rest/users/{id}/statusInMaarchParapheur

Le paramètre id de la route représente l'identifiant technique de l'utilisateur Maarch Courrier.

Retour¶

Code Http	Type	Description	Exemple
`200`	json	Renvoyer le login de l'utilisateur Maarch	{linbk: "bbain", "errors": ""}
`400`	array	L'utilisateur n'a pas d'identifiant Maarch Parapheur	['errors' => 'User does not have Maarch Parapheur Id']
`403`	array	Maarch Parapheur n'est pas activé	['errors' => 'maarchParapheur is not enabled']

Exemple¶

{
  "link": "bbain",
  "errors": ""
}