организации
Ресурс организации помогает связать вместе все другие ресурсы API, которые относятся к клиенту API (здесь клиент - клиент API, а не реализация клиента API).
Организация должна быть настроена, прежде чем ее ключи API можно будет использовать для выполнения операций извлечения данных с API. По крайней мере, без правильной конфигурации хранилища API не будет знать, как публиковать результаты.
Организация отслеживает набор базовых разрешений. Они описывают, какие ключи операций в организации разрешено выполнять с API.
Атрибуты
| название | тип | описание |
|---|---|---|
id | идентификатор организации | Идентификатор ресурса. |
resource | строка, всегда organisation | Спецификатор типа ресурса. |
type | супер, строка | Один из: standard , super . |
name | строка | Выбранное название для организации. |
slug | строка | Slugified версия name . |
api_version | Версия API | Версия API, на которой настроена организация. |
permissions | ресурс разрешений | Вложенный ресурс разрешений . |
storage_configs | список объектов, содержащих ресурсы конфигурации хранилища | Вложенный список объектов конфигурации хранилища, связанных с организацией. |
storage_config_default | опционально, идентификатор конфигурации хранилища | Идентификатор конфигурации хранилища организации по умолчанию. |
webhook_configs | список объектов, содержащих ресурсы конфигурации webhook | Вложенный список объектов конфигурации webhook, связанных с организацией. |
webhook_config_default | необязательно, идентификатор конфигурации webhook | Идентификатор конфигурации webhook организации по умолчанию. |
state | строка | Один из: unconfigured , active , deactivated , blocked . |
date_created | Дата и время | Когда ресурс был создан. |
Типы
-
standard - Для клиентов API.
-
super - Для внутренних менеджеров API.
права доступа
Значение permissions указывает набор базовых разрешений для организации. Это наименее строгие разрешения, предоставляемые любому подресурсу этой организации, т. Е. Ключ или пользователь не могут иметь доступ к большему количеству данных, чем организация, к которой он принадлежит.
состояния
-
unconfigured - Каждая организация создается в этом состоянии. Нахождение в этом состоянии блокирует доступ к большинству функций поиска данных.
-
active - Организация была настроена и может использовать все части API.
-
deactivated - Организация была закрыта по требованию владельца.
-
blocked - Организация была закрыта администратором API.
Изменения
2020-02-20
- Основные
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 | идентификатор конфигурации хранилища | Измените конфигурацию хранилища по умолчанию, используемую вашей организацией. |
webhook_config_default | идентификатор конфигурации webhook | Измените конфигурацию 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" }
