Gestion en masse des utilisateurs membres  d'un rôle

Plutôt que de procéder utilisateur par utilisateur, il y a possibilité de faire des opérations sur un ensemble d'utilisateurs avec le WebService accessible à l'adresse /api/roles/<role_uuid>/relationships/members/.

Paramètres : une liste d'utilisateurs identifiés par leur uuid

Exemple de paramètres

{
    "data": [
        {"uuid": "6805d2b4f4ab4b6c94a28588a46bb40a"},
        {"uuid": "12e4a3f2fdc241968a102bcbf22f4edf"}
    ]
}

Ajouter des utilisateurs dans un rĂ´le

Via la méthode POST.

Exemple

POST  /api/roles/debb96a7ff5d486fb323e3edbeb8f0f7/relationships/members/  HTTP/1.1 
Content-Type: application/json
Authorization: Basic xxxx
Content-Length: xxx

{
    "data": [
        {"uuid": "6805d2b4f4ab4b6c94a28588a46bb40a"},
        {"uuid": "12e4a3f2fdc241968a102bcbf22f4edf"}
    ]
}

Retour Passant

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: xxx

{
    "detail": "Utilisateurs ajoutés au rôle avec succès",
    "result": 1
}

DĂ©finir l'ensemble des utilisateurs appartenant Ă  un rĂ´le

Via la méthode PATCH ou PUT. Cette méthode ajoute les utilisateurs passés en paramètre dans le rôle correspondant. Les utilisateurs déjà présents dans le rôle mais qui ne sont pas passés en paramètre seront retirés du rôle.

Exemple

PATCH  /api/roles/debb96a7ff5d486fb323e3edbeb8f0f7/relationships/members/  HTTP/1.1 
Content-Type: application/json
Authorization: Basic xxxx
Content-Length: xxx

{
    "data": [
        {"uuid": "6805d2b4f4ab4b6c94a28588a46bb40a"},
        {"uuid": "12e4a3f2fdc241968a102bcbf22f4edf"}
    ]
}

Retour Passant

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx

{
    "detail": "Utilisateurs assignés au rôle avec succès",
    "result": 1
}

Suppression de tous les utilisateurs d'un rĂ´le

Via la méthode DELETE en ajoutant le paramètre ?all à l'URL.

Vous n'avez pas trouvé ce que vous cherchez ?

Une suggestion ? Écrivez-nous !

Proposez une amélioration pour la documentation

Dernière mise à jour le 24/07/2026 11:59