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

Méthode list (objet group)

Description

Dresse la liste des groupes dans la base de données de service d'annuaire local du contrôleur de grille et des groupes dans la base de données de service d'annuaire global (si la grille est configurée pour utiliser ce service).

Syntaxe

/api/v2/group/list?vdc=controller-name 

Arguments

vdc (facultatif)

Nom du centre de données virtuel cible

Type de transaction

Synchrone

Type de requête

GET

Exemples

Dresser la liste des groupes

GET
http://192.168.123.200/api/v2/group/list?vdc=mygrid

Dresser la liste des groupes locaux

GET
http://192.168.123.200/api/v2/group/list?local&vdc=mygrid

Dresser la liste des groupes globaux

GET
http://192.168.123.200/api/v2/group/list?global&vdc=mygrid

Exemple de sortie

JSON

{
   "group" : [
      {
         "can_own" : "0",
         "name" : "local:admin",
         "description" : "",
         "scope" : "local"
      },
      {
         "can_own" : "0",
         "name" : "local:all",
         "description" : "inclut implicitement tous les utilisateurs en tant que membres",
         "scope" : "local"
      }
   ]
}

XML

<groups>
  <group>
    <can_own>0</can_own>
    <description></description>
    <name>local:admin</name>
    <scope>local</scope>
  </group>
  <group>
    <can_own>0</can_own>
    <description>Inclut implicitement tous les utilisateurs en tant que membres.</description>
    <name>local:all</name>
    <scope>local</scope>
  </group>
</groups>

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.

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