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

Méthode get_acl (objet app)

Description

Récupérer la liste de contrôle d'accès de l'application ou la partie de cette liste qui se rapporte à un principal spécifique

Syntaxe

/api/v2/app/get_acl?app=application&principal=<principal>&vdc=controller-name

Arguments

app

Nom de l'application

principal

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

vdc

Nom du centre de données virtuel cible

Type de transaction

Synchrone

Type de requête

GET

Exemple : récupération de la liste de contrôle d'accès de l'application

Récupérer la liste de contrôle d'accès de l'application test

GET http://192.168.123.200/api/v2/app/get_acl?app=test&principal=&vdc=mygrid 

Exemple de sortie

JSON

{
   "acl" : {
      "owner" : {
         "id" : ""
      },
      "entries" : [
         {
            "configure" : 1,
            "id" : "778fee4e-9b83-4160-8b79-8bb0e1a87af8"
         }
      ]
   }
}

XML

<acl>
  <entries>
    <entry>
      <configure>1</configure>
      <id>778fee4e-9b83-4160-8b79-8bb0e1a87af8</id>
    </entry>
  </entries>
  <owner>
    <id></id>
  </owner>
</acl>

Exemple : récupération des données de la liste de contrôle d'accès pour le principal

Récupérer les données de la liste de contrôle d'accès pour le principal local:user:api@3tera.com et l'application test

GET
http://192.168.123.200/api/v2/app/get_acl?app=test&principal=local%3Auser%3Aapi%403tera.com&vdc=mygrid

Exemple de sortie

JSON

{
   "acl" : {
      "owner" : {
         "id" : ""
      },
      "entries" : [
         {
            "id" : "f9939715-e340-4e09-b179-f61e3b031338",
            "full" : 1
         },
         {
            "id" : "932b639b-2f78-4415-9c3b-22a2a98ce9fe",
            "full" : 1
         },
         {
            "configure" : 1,
            "id" : "778fee4e-9b83-4160-8b79-8bb0e1a87af8"
         }
      ]
   }
}

XML

<acl>
  <entries>
    <entry>
      <full>1</full>
      <id>f9939715-e340-4e09-b179-f61e3b031338</id>
    </entry>
    <entry>
      <full>1</full>
      <id>932b639b-2f78-4415-9c3b-22a2a98ce9fe</id>
    </entry>
    <entry>
      <configure>1</configure>
      <id>778fee4e-9b83-4160-8b79-8bb0e1a87af8</id>
    </entry>
  </entries>
  <owner>
    <id></id>
  </owner>
</acl>

Codes d'erreur HTTP

404

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 (app). 
- La requête ne contient pas l'argument app=application.

Missing required arguments (principal)
- Argument principal=principal manquant

404.1

Entity not found - Application test does not exist.

- Une application spécifiée n'existe pas sur mygrid.

Entity not found - Failed to retrieve application ACL - ACL does not contain principal local user 'test@3tera.com'.

- 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.