組織

更新しました
Cover image for: 組織

組織リソースは、APIのクライアントに関連する他のすべてのAPIリソースをリンクするのに役立ちます(ここでクライアントはAPIクライアントであり、APIクライアント実装ではありません)。

APIキーを使用してAPIに対してデータ取得操作を実行する前に、組織を構成する必要があります。少なくとも有効なストレージ設定がないと、APIは結果を公開する方法を知りません。

組織は一連の基本権限を追跡します。これらは、組織内のどの操作キーがAPIに対して実行を許可されているかを説明します。

属性

タイプ説明
id 組織ID リソース識別子
resource 文字列、常にorganisation リソースタイプ指定子
type スーパー、ひものいずれか: standardsuper
name ひも組織に選ばれた名前。
slug ひも不名誉なバージョンのname
api_version APIバージョン組織が使用するように構成されているAPIバージョン。
permissions 権限リソース入れ子になった権限リソース。
storage_configs ストレージ構成リソースを含むリストオブジェクト組織に関連付けられたストレージ構成オブジェクトのネストされたリスト。
storage_config_default オプション、ストレージ構成ID 組織のデフォルトのストレージ設定のID。
webhook_configs webhook設定リソースを含むリストオブジェクト組織に関連付けられたWebhook構成オブジェクトのネストされたリスト。
webhook_config_default オプション、ウェブフック設定ID 組織のデフォルトのWebhook設定のID。
state ひも unconfiguredactivedeactivatedblockedです。
date_created 日付時刻リソースが作成されたとき

タイプ

standard
APIのクライアントのために。
super
APIの内部管理者向けです。

許可

permissions値は、組織の基本権限のセットを指定します。これらは、その組織のすべてのサブリソースに与えられる最も厳格でないアクセス権です。つまり、キーまたはユーザーは、それが属する組織よりも多くのデータにアクセスすることはできません。

unconfigured
すべての組織はこの状態で作成されます。この状態にあると、ほとんどのデータ検索機能へのアクセスがブロックされます。
active
組織は構成されており、APIのすべての部分を使用できます。
deactivated
所有者の要求により、組織は閉鎖されました。
blocked
組織はAPI管理者によって閉鎖されました。

変更ログ

2020-02-20

  • Major組織オブジェクトのstorage_configsおよびwebhook_configs属性が、単純なリスト属性ではなく、ネストされたリストオブジェクトになりました。

GET /organisation取得する

cURLを使う

curl https://ricloud-api.reincubate.com/organisation \
  -H 'Authorization: Token <your key_token>'

ricloud-pyを使う

import ricloud

ricloud.Organisation.retrieve()

サンプル応答

{
  "id": 1,
  "resource": "organisation",
  "name": "My org",
  "slug": "my-org",
  "api_version": "2020-02-20",
  "permissions": {
    "id": 1,
    "resource": "organisation_permissions",
    "identifier": "default",
    "scopes": {
      "source_type:icloud.*": [],
      "task_type:*": [],
      "data_type:icloud.account.info": [],
    },
    "date_created": "2018-11-08T13:05:29.954188Z"
  },
  "storage_configs": {
    "data": [
      {
        "id": 1,
        "resource": "storage_config",
        "type": "gs",
        "url": "gs://my-storage-bucket",
        "credentials": {},
        "state": "valid",
        "date_created": "2018-11-08T16:47:56.849618Z"
      }
    ],
    "has_more": false,
    "total_count": 1,
    "url": "/configs/storage"
  },
  "storage_config_default": 1,
  "webhook_configs": {
    "data": [
      {
        "id": 1,
        "resource": "webhook_config",
        "url": "https://www.mywebhookendpoint.com/webhooks",
        "secret": "Wg69dQaffJuXckXsdoHuPYkf3VSWEGMa",
        "state": "valid",
        "date_created": "2018-11-08T13:07:59.563975Z"
      }
    ],
    "has_more": false,
    "total_count": 1,
    "url": "/configs/webhook"
  },
  "webhook_config_default": 1,
  "state": "active",
  "date_created": "2018-11-08T13:05:29.784270Z"
}

POST /organisation更新する

パラメーター

タイプ説明
name ひも組織の表示名を変更してください。
storage_config_default ストレージ構成ID 組織で使用されているデフォルトのストレージ構成を変更します。
webhook_config_default ウェブフック設定ID 組織で使用されているデフォルトのWebhook設定を変更します。

cURLを使う

curl 'https://ricloud-api.reincubate.com/organisation' \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "My new organisation name"
}'

ricloud-pyを使う

import ricloud

ricloud.Organisation.update(name='My new org')

サンプル応答slug属性は、最初の組織の作成時にのみ生成されるため変更されません。

{
  "id": 1,
  "resource": "organisation",
  "name": "My new org",
  "slug": "my-org",
  "permissions": {},
  "storage_configs": {
    "data": [
      {
        "id": 1,
        "resource": "storage_config",
        "type": "gs",
        "url": "gs://my-storage-bucket",
        "credentials": {},
        "state": "valid",
        "date_created": "2018-11-08T16:47:56.849618Z"
      }
    ],
    "has_more": false,
    "total_count": 1,
    "url": "/configs/storage"
  },
  "storage_config_default": 1,
  "webhook_configs": {
    "data": [
      {
        "id": 1,
        "resource": "webhook_config",
        "url": "https://www.mywebhookendpoint.com/webhooks",
        "secret": "Wg69dQaffJuXckXsdoHuPYkf3VSWEGMa",
        "state": "valid",
        "date_created": "2018-11-08T13:07:59.563975Z"
      }
    ],
    "has_more": false,
    "total_count": 1,
    "url": "/configs/webhook"
  },
  "webhook_config_default": 1,
  "state": "active",
  "date_created": "2018-11-08T13:05:29.784270Z"
}

どのように我々は助けることができます?

サポートチームがお手伝いします!

営業時間は月曜日から金曜日の午前9時から午後5時(GMT)です。 時間は現在 9:16 AM GMTです。

1営業日以内に、お返事を差し上げます。メールアドレスはこちら。

サポートセクションに移動 › エンタープライズチームに連絡する ›
私たちの素晴らしいサポートチーム

この記事を改善できますか?

ユーザーからの連絡をお待ちしています。電子メールを送信したり、コメントを残したり、ツイートしたりしないでください。 @reincubate?

© 2008 - 2020 Reincubate Ltd. 無断複写・転載を禁じます。 イングランドとウェールズに登録 #5189175, VAT GB151788978. ReincubateおよびCamoは商標です。 個人情報保護方針 & 条項. マルチファクタ認証をお勧めします。 ロンドンで愛と建てられた。