источники

обновленный

Источник представляет собой источник данных из службы. Например, учетная запись iCloud является источником службы iCloud.

Sources can have child sources, such as a rirelay.instance source having multiple rirelay.source sources which can be targeted individually.

Атрибуты

название тип описание
id идентификатор источника Идентификатор ресурса.
resource строка, всегда source Спецификатор типа ресурса.
user Идентификатор пользователя Пользователь, связанный с этим источником.
type string The type of this source, for example icloud.account.
identifier string A unique identifier for the source within the scope of its service.
parent необязательно, идентификатор источника Заполняется, если источник является дочерним от другого.
children список объектов, содержащих исходные ресурсы Содержит любые подисточники источника.
state строка Один из: не unvalidated , active , deactivated , blocked , locked .
date_created Дата и время Когда ресурс был создан.

Типы

В настоящее время поддерживаются следующие типы:

  • icloud.account, the primary source on the iCloud service.
  • rirelay.instance, the primary source on the rirelay service. Corresponds to an instance of the Reincubate Relay application.
  • rirelay.source, a child source of rirelay.instance. Corresponds to a device that the parent Reincubate Relay app has access to.

Идентификатор

Значение атрибута идентификатора источника identifier его уникально в пределах его службы. Для учетной записи iCloud это будет имя пользователя. Для экземпляра приложения Reincubate Relay это будет идентификатор экземпляра.

родитель

Если источник является дочерним источником, это поле будет указывать на его родительский исходный объект. Верхний источник в этой иерархии называется основным источником.

A child source cannot be created directly via the API, but are automatically created by the API when the appropriate poll is created.

состояния

unvalidated
сеанс никогда не был успешно создан для этого источника, поэтому API не может определить, является ли он допустимым источником.
active
источник был проверен и готов к использованию.
deactivated
доступ к источнику был запрещен организацией-владельцем.
blocked
доступ к источнику был запрещен администратором API.
locked
доступ к источнику был временно ограничен внешней службой.

Получить GET /sources/{source ID}

Использование cURL

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

Использование ricloud-py

import ricloud

source = ricloud.Source.create(<source ID>)

Образец ответа

{
  "id": 1,
  "resource": "source",
  "user": 1,
  "type": "mocks.mock",
  "identifier": "john.appleseed@reincubate.com",
  "info": null,
  "parent": null,
  "children": {
      "data": [],
      "has_more": false,
      "total_count": 0,
      "url": "/sources/1/children"
  },
  "state": "active",
  "date_created": "2020-02-20T11:59:03.195527Z"
}

Список GET /sources

название тип описание
organisation супер, идентификатор организации Для администраторов API для фильтрации по организации.
user Идентификатор пользователя Фильтровать по связанному пользователю.
type строка Фильтр по типу источника.
identifier строка Фильтр по идентификатору источника.
state строка Фильтр по состоянию источника.
date_created фильтр даты и времени Фильтр по дате создания ресурса.

Использование cURL

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

Использование ricloud-py

import ricloud

sources = ricloud.Source.list()

Обновить POST /sources/{source ID}

имя тип описание
state строка Обновите исходное состояние.

Использование cURL

curl https://ricloud-api.reincubate.com/sources/<source ID> \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "state": "deactivated"
}'

Использование ricloud-py

import ricloud

source = ricloud.Source.update_with_id(<source ID>, state='deactivated')

# OR

source = ricloud.Source.retrieve(<source ID>)

source.update(state='deactivated')

Изменения

2020-02-20

  • Major Атрибут children исходного объекта теперь является вложенным списком, а не простым списком.

2019-10-16

  • Добавляет два новых типа источников: rirelay.instance и rirelay.source .

Как мы можем помочь?

Наша служба поддержки здесь, чтобы помочь!

Наш офис работает с понедельника по пятницу с 9:00 до 17:00 по Гринвичу. Время в настоящее время 11:34 ДП с GMT.

Мы стремимся отвечать на все сообщения в течение одного рабочего дня.

Перейти в раздел поддержки › Связаться с командой предприятия ›
Наша отличная команда поддержки

© 2008 - 2020 Reincubate Ltd. Все права защищены. Зарегистрировано в Англии и Уэльсе #5189175, VAT GB151788978. Reincubate® является зарегистрированным товарным знаком. Политика конфиденциальности & условия. Мы рекомендуем 2FA. Построен с в Лондоне.