Documentation en ligne

Modifier un rôle

La création d'un rôle se fait avec le WebService accessible à l'adresse /api/roles/<uuid>/ via la méthode HTTP PATCH ou PUT en soumettant un document JSON décrivant le rôle à créer.

Paramètres

Propriété

Description

Valeur requise

Valeur permise

name nom non chaîne quelconque
slug identifiant court non chaîne quelconque
ou identifiant d'une collectivité non chaîne quelconque

Les valeurs null ne sont pas autorisées.

Exemple

POST /api/roles/3b8e9fc0f6ae4731b5bbec2812f7d370/ HTTP/1.1 
Content-Type: application/json
Authorization: Basic xxxx
Content-Length: xxx

{
    "name": "Fooaa" 
}

Retour Passant

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

{
    "name": "Fooaa",
    "ou": "default",
    "slug": "foo",
    "uuid": "3b8e9fc0f6ae4731b5bbec2812f7d370"
}


Cas non-passant

Code

Signification

Contenu

400 Le format de la requête est invalide (paramètre interdit ou avec une valeur invalide) Un document JSON décrivant les erreurs rencontrées
401 L'authentification a échouée  
403 Permission non accordée d'effectuer l'action  

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