Documentation en ligne

Lister les rôles

La liste des rôles se fait avec un même WebService accessible à l'adresse /api/roles/ via la méthode HTTP GET. Il n'est pas possible de filtrer les résultats selon certains attributs du rôle.

Format de retour

Le document retour est un objet/dictionnaire JSON, les résultats sont toujours paginés, chaque page a une taille de 100, le lien vers la page suivante est dans la propriété next et celui vers la page précédente dans la propriété previous. La propriété results contient la liste des résultats.

Les attributs sont les suivants :

Propriété

Description

Format

name nom chaîne quelconque
ou unité organisationnelle chaîne quelconque
slug identifiant court chaîne quelconque
uuid identifiant chaîne hexadécimal

Exemple

GET /api/roles/ HTTP/1.1
Authorization: Basic xxx

200 Ok
Content-Type: application/json
Content-Length: xxxx

{
    "next": "https://foo.com/api/roles/?limit=10&offset=10",
    "previous": null,
    "results": [
         {                                                                                          
            "name": "Foo",                            
            "ou": "default",                          
            "slug": "foo",                         
            "uuid": "99aa781541e84b51b47c9e379bc282a8"
        },                                            
        {                    
            "name": "Bar",                           
            "ou": "default",                      
            "slug": "bar",                         
            "uuid": "38aa46545f11430a82c4efcf435bd8e7"
        }
     .....
    ]
}

Dernière mise à jour le 12 avril 2021 16:40 — Éditer