リファレンス · アカウント

組織

ユーザーがアクセスできる組織と、各組織でAPIから参照できる内容を一覧表示します。このレスポンスはページ分割されません。

パラメーター

このエンドポイントにはパラメーターはありません。

各項目のフィールド

uid string

組織の識別子。一覧のorganizationパラメーターで使用します。

name string

組織名。

neutral_zone boolean

ニュートラルゾーン組織の場合はtrue。ニュートラルゾーン組織のファイルとプレイリストは、他のすべての組織で使用できます。

admin boolean

ユーザーがその組織またはメイン組織の管理者である場合はtrue。この場合、ユーザーは組織内のすべてを参照できます。

permissions object

その組織でユーザーが参照できる内容。

permissions.tvs boolean

TVを閲覧できる場合はtrue。

permissions.files boolean

ファイルを閲覧できる場合はtrue。

permissions.playlists boolean

プレイリストを閲覧できる場合はtrue。

発生しうるエラー

• キーとレート制限に関するエラーは、すべてのエンドポイントに共通です。 すべてのエラーを見る

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
      }
    }
  ]
}