Référence · Compte

Organisations

Liste les organisations auxquelles l'utilisateur a accès et, pour chacune, ce qu'il peut consulter via l'API. Cette réponse n'est pas paginée.

Paramètres

Cet endpoint ne prend aucun paramètre.

Champs de chaque élément

uid string

Identifiant de l'organisation. À utiliser dans le paramètre organization des listes.

name string

Nom de l'organisation.

neutral_zone boolean

true s'il s'agit d'une organisation de zone neutre, dont les fichiers et les playlists peuvent être utilisés par toutes les autres organisations.

admin boolean

true si l'utilisateur est administrateur de l'organisation ou de l'organisation principale. Dans ce cas, il voit tout dans l'organisation.

permissions object

Ce que l'utilisateur peut consulter dans cette organisation.

permissions.tvs boolean

true s'il peut voir les TVs.

permissions.files boolean

true s'il peut voir les fichiers.

permissions.playlists boolean

true s'il peut voir les playlists.

Erreurs possibles

• Les erreurs de clé et de limite s'appliquent à tous les endpoints. Voir toutes les erreurs

curl "https://api.on-cloud.live/v1/organizations" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/organizations');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('API_KEY')],
]);
$response = json_decode(curl_exec($ch), true);

const res = await fetch('https://api.on-cloud.live/v1/organizations', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

{
  "data": [
    {
      "uid": "8f14e45fceea167a5a36dedd4bea2543",
      "name": "Loja Centro",
      "neutral_zone": false,
      "admin": true,
      "permissions": {
        "tvs": true,
        "files": true,
        "playlists": true
      }
    },
    {
      "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
      "name": "Loja Shopping Norte",
      "neutral_zone": false,
      "admin": true,
      "permissions": {
        "tvs": true,
        "files": true,
        "playlists": true
      }
    }
  ]
}