Introduction Guide de l'utilisateur Guide administrateur fonctionnel Guide administrateur technique Installation Prérequis pour Maarch Parapheur Migration Exploitation Architecture technique Description du modèle de données Description des webservices Configurations Documents Utilisateurs

Users

Création d'un utilisateur

Route

POST /rest/users

Paramètres

Body
Valeur Type Obligatoire Description
login string Oui Identifiant de l'utilisateur (utilisé pour se connecter)
email string Oui Email de l'utilisateur
firstname string Oui Prénom de l'utilisateur
lastname string Oui Nom de l'utilisateur
picture base64 Non Avatar de l'utilisateur
mode string Non Mode de connexion de l'utilisateur (standard, rest)
Exemple
{
    "login" : "user@maarch.com",
    "firstname" : "prenom",
    "lastname" : "nom",
    "email" : "user@maarch.com"
}

Retour

Code Http Type Description Exemple
200 array L'utilisateur a été créé ['id' => 12]
400 array Un paramètre obligatoire est manquant ou dans le mauvais format ['errors' => '...']
500 array Une erreur s'est produite ['errors' => '...']

Récupération de la liste des utilisateurs

(Certains privilèges sont requis pour récupérer cette liste)

Route

GET /rest/users

Retour

Code Http Type Description
200 array Liste des utilisateurs
400 array Message d'erreur
403 array Privilège insuffisant
Données
Valeur Type Description
id integer Identifiant technique de l'utilisateur
login string Identifiant de l'utilisateur
firstname string Prénom
lastname string Nom de famille
substitute boolean Indique si l'utilisateur a déléguer son parapheur
email string Courriel de l'utilisateur
Exemple
{
    "users": [
                {
                    "id": 1,
                    "login": "rocky@balboa.com",
                    "firstname": "Sylvester",
                    "lastname": "Stallone",
                    "substitute": false,
                    "email": "rocky@maarch.org"
                },
                {
                    "id": 2,
                    "login": "walker.texas@ranger.com",
                    "firstname": "Chuck",
                    "lastname": "Norris",
                    "substitute": false,
                    "email": "walker@maarch.org"
                }
        ]
}

Mise à jour des signatures externes d'un utilisateur

Route

PUT /rest/users/{id}/externalSignatures

Paramètres

Body
Valeur Type Obligatoire Description
externalApplication string Oui Nom de l'application externe
signatures array Oui Signatures

Le tableau signatures peut contenir 1 à N signatures. Chaque signature représente une case de ce tableau.

Exemple
{
    "externalApplication" : "MaarchCourrier",
    "signatures" : [
        {
            "format" : "png",
            "encodedSignature" : "deJOIJKiSDYUIfolpcdm"
        },
        {
            "format" : "jpeg",
            "encodedSignature" : "REUGFMLLlpxjeoikjcxoe668v"
        }
    ]
}

Retour

Code Http Type Description Exemple
204 array Les signatures ont bien été créées
400 array Un paramètre obligatoire est manquant ['errors' => '...']
403 array Le privilege 'manage_users' est obligatoire pour administrer un autre utilisateur ['errors' => 'Privilege forbidden']
500 array Une erreur s'est produite ['errors' => '...']

results matching ""

    No results matching ""