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

Méthode put (objet group)

Description

Remplace la description et tous les membres d'un groupe local.

Syntaxe

/api/v2/group/put?group=group&description=description&principal=principal&vdc=controller-name 

Arguments

groupe

Nom du groupe

description

Description du propriétaire du groupe encodée au format URL

principal

Liste de principaux 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 et l'appartenance au groupe par le principal unique local:user:api@3tera.com pour mygroup

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

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

GET
http://192.168.123.200/api/v2/group/put?group=mygroup&description=API%20Group&principal=local%3Auser%3Aapi%403tera.com%2Flocal%3Auser%3Atest%403tera.com&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 (group)

- Argument group=group manquant

Missing required arguments (description)

- Argument description=description manquant

Missing required arguments (principal)

- Argument principal=principal manquant

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.