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.
Paramètres
|
Nom |
Sémantique |
Valeurs permises |
Exemple |
|---|---|---|---|
|
uuid |
rechercher un rôle par son identifiant |
chaîne hexadécimale |
9c05a50defd6412a9580a455e6c69cd0 |
|
name |
recherche exacte sur le nom pour une valeur exacte |
chaîne quelconque |
Administrateur |
|
name__iexact |
recherche exacte sur le nom pour une valeur exacte en ignorant la casse |
chaîne quelconque |
administrateur |
|
name__icontains |
recherche exacte sur le nom pour une sous chaîne en ignorant la casse |
chaîne quelconque |
ministr |
|
name__startswith |
recherche exacte sur le début du nom |
chaîne quelconque |
Admin |
|
slug |
recherche exacte sur l'identifiant court (slug) pour une valeur exacte |
chaîne quelconque |
_a2-manager |
|
slug__iexact |
recherche exacte sur l'identifiant court (slug) pour une valeur exacte en ignorant la casse |
chaîne quelconque |
_A2-Manager |
|
slug__icontains |
recherche exacte sur l'identifiant court (slug) pour une sous chaîne en ignorant la casse |
chaîne quelconque |
Manage |
|
slug__startswith |
recherche sur le début de l'identifiant court (slug |
chaîne quelconque |
_a2- |
|
ou__slug |
recherche dans une unité organisationnelle |
identifiant court (slug) de l'unité organisationnelle |
|
|
limit |
nombre maximum d'enregistrements retournés |
entier |
50 |
|
offset |
position du premier enregistrement à retourner relativement à l'ensemble total des enregistrement concernés par la requête |
entier |
100 |
|
ordering |
Permet de passer le nom d'un champ par lequel les réponses seront ordonnées, préfixé par - l'ordre est inversé |
nom d'un attribut (name, slug) | - |
| admin | Filtre (true) ou exclut (false) les rôles d'administrations, ceux dont le slug commence par _a2-manager | true ou false | true |
| internal | Filtre (true) ou exclut (false) les rôles internes, ceux dont le slug commence par un _ | true ou false | true |
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"
}
.....
]
}