Manuels d'intégration › Manuel de référence de l'API de service Web › Objets valides › Objet group › Méthode modify (objet group)

Méthode modify (objet group)

Description

Remplace la description ou des membres d'un groupe local.

Syntaxe

/api/v2/group/modify?group=group&add_principal=add_principal&remove_principal=remove_principal&vdc=controller-name 

Arguments

groupe

Nom du groupe

add_principal

Liste de principaux à ajouter au groupe, encodés au format URL et séparés par des barres obliques (/).

Par exemple, local:user:api@3tera.com doit être passé sous la forme local%3Auser%3Aapi%403tera.com

Par exemple, local:user:api@3tera.com /local:user:test@3tera.com doit être passé sous la forme local%3Auser%3Aapi%403tera.com%2Flocal%3Auser%3Atest%403tera.com

remove_principal

Liste de principaux à supprimer du groupe, encodés au format URL et séparés par des barres obliques (/).

Par exemple, local:user:api@3tera.com doit être passé sous la forme local%3Auser%3Aapi%403tera.com

Par exemple, local:user:api@3tera.com /local:user:test@3tera.com doit être passé sous la forme local%3Auser%3Aapi%403tera.com%2Flocal%3Auser%3Atest%403tera.com

vdc

Nom du centre de données virtuel cible

Type de transaction

Synchrone

Type de requête

GET

Exemples

Remplace l'intégralité de la description par API GROUP, sans changer l'appartenance au groupe.

                                                                                                                                   
GET
http://192.168.123.200/api/v2/group/modify?group=mygroup&description=API%20Group&add_principal=&remove_principal=&vdc=mygrid

Remplace l'intégralité de la description par API GROUP, ajoute local:user:api@3tera.com à mygroup et supprime local:user:test@3tera.com de mygroup

GET
http://192.168.123.200/api/v2/group/put?group=mygroup&description=API%20Group&add_principal=local%3Auser%3Aapi%403tera.com&remove_principal=local%3Auser%3Atest%403tera.com&vdc=mygrid

Remplace l'intégralité de la description par API GROUP et supprime local:user:api@3tera.com et local:user:test@3tera.com de mygroup

GET
http://192.168.123.200/api/v2/group/put?group=mygroup&description=API%20Group&remove_principal=local%3Auser%3Aapi%403tera.com%2Flocal%3Auser%3Atest%403tera.com&add_principal=&vdc=mygrid

Exemple de sortie

JSON

{
   "message" : ""
} 

XML

<message></message>

Codes d'erreur HTTP

400

L'entité vdc mygrid est introuvable.
- Le nom de VDC spécifié n'est pas configuré dans l'application WS_API.

400.4

Missing required arguments (add_principal, remove_principal, can_own or description).

404.1

Entity not found – Group mygroup does not exist.

- Un groupe spécifié n'existe pas sur mygrid.

Entity not found - Failed to put application ACL - invalid principal data - principal local user 'test@3tera.com' does not exist.

- Un principal non valide a été spécifié

Remarque : Cette API est disponible avec WS_API_r6-1.0.6-1 et les versions ultérieures.