Integrationshandbücher › Webservice-API-Referenzhandbuch › Gültige Objekte › group-Objekt › modify-Methode (group-Objekt)

modify-Methode (group-Objekt)

Description

Beschreibung oder Mitgliedschaft einer lokalen Gruppe ersetzen.

Syntax

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

Argument

Gruppe

Name der Gruppe

add_principal

URL-kodierte Liste mit Prinzipalen, die der Gruppe hinzugefügt werden sollen, mit "/" als Trennzeichen.

local:user:api@3tera.com sollte z. B. als local%3Auser%3Aapi%403tera.com übergeben werden.

local:user:api@3tera.com /local:user:test@3tera.com sollte z. B. als local%3Auser%3Aapi%403tera.com%2Flocal%3Auser%3Atest%403tera.com übergeben werden.

remove_principal

URL-kodierte Liste mit Prinzipalen, die aus der Gruppe entfernt werden sollen, mit "/" als Trennzeichen.

local:user:api@3tera.com sollte z. B. als local%3Auser%3Aapi%403tera.com übergeben werden.

local:user:api@3tera.com /local:user:test@3tera.com sollte z. B. als local%3Auser%3Aapi%403tera.com%2Flocal%3Auser%3Atest%403tera.com übergeben werden.

vdc

Name des virtuellen Rechenzentrums (Virtual Data Center), welches das Ziel darstellt

Transaktionsart

synchron

Anfragetyp

GET

Beispiele

Gesamte Beschreibung durch "API GROUP" ersetzen, aber nicht die Mitgliedschaft ändern.

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

Ersetzen Sie die gesamte Beschreibung durch "API GROUP", und fügen Sie local:user:api@3tera.com der Mitgliedschaft hinzu und entfernen Sie local:user:test@3tera.com aus 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

Ersetzen Sie die gesamte Beschreibung durch "API GROUP", und entfernen Sie local:user:api@3tera.com und local:user:test@3tera.com aus 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

Beispielausgabe

JSON:

{
   "message": "",
} 

XML:

<message></message>

HTTP-Fehlercodes

400

Entität vdc mygrid nicht gefunden.
- Ein VDC-Name wurde angegeben, der in der WS_API-Anwendung nicht konfiguriert ist.

400.4

Erforderliche Argumente fehlen (add_principal, remove_principal, can_own oder description).

404.1

Entität nicht gefunden - Gruppe mygroup ist nicht vorhanden.

- Eine Gruppe wurde angegeben, die nicht auf mygrid vorhanden ist.

Entität nicht gefunden - Anwendungs-ACL kann nicht erstellt werden - ungültige Prinzipal-Daten - lokaler Prinzipal-Benutzer "test@3tera.com" ist nicht vorhanden.

- Ein ungültiger Prinzipal wurde angegeben.

Hinweis: Diese API ist verfügbar mit WS_API_r6-1.0.6-1 und höher.