пользователей

обновленный

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

Важно последовательно идентифицировать конечных пользователей, чтобы обеспечить наивысший уровень безопасности данных и обеспечить лучший пользовательский опыт.

Атрибуты

название тип описание
id Идентификатор пользователя Идентификатор ресурса.
resource строка, всегда user Спецификатор типа ресурса.
organisation идентификатор организации Организация, к которой принадлежит ресурс.
key идентификатор ключа Ключ, с которым связан ресурс.
identifier строка Пользовательское значение, чтобы помочь идентифицировать пользователя и избежать дублирования. Например, это может быть адрес электронной почты конечного пользователя.
state строка Один из: active , deactivated , blocked .
date_created Дата и время Когда ресурс был создан.

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

Атрибут identifier не используется API, но должен служить мостом между вашей реализацией и информацией, хранящейся в API. Значение этого атрибута должно обеспечивать прямое сопоставление пользователя вашей системы с пользователем в API. Это может быть идентификатор пользователя в вашей системе или адрес электронной почты конечного пользователя.

состояния

active
стандартное состояние пользователя.
deactivated
организация-владелец отключила доступ этого пользователя.
blocked
администратор API отключил доступ этого пользователя.

Создать POST /users

параметры

название тип описание
organisation супер Позволяет администраторам API создавать пользователей от имени других организаций.
key по умолчанию: текущий ключ Назначьте пользователя на отдельный ключ. Возможно, тот, у кого меньше разрешений, например.
identifier требуется строка Часть информации, чтобы идентифицировать этого пользователя с конечным пользователем в вашей системе.

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

curl https://ricloud-api.reincubate.com/users \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "identifier": "end-user@email.com",
}'

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

import ricloud

user = ricloud.User.create(identifier='end-user@email.com')

Получить GET /users/{user ID}

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

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

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

import ricloud

user = ricloud.User.retrieve(<user ID>)

Список GET /users

параметры

название тип описание
key идентификатор ключа Отфильтруйте пользователей по ключу, с которым они связаны.
identifier строка Отфильтруйте пользователей по их идентификатору.
state строка Фильтруйте пользователей по их состоянию.
date_created фильтр даты и времени Фильтр по дате создания ресурса.

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

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

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

import ricloud

users = ricloud.User.list()

Обновить POST /users/{user ID}

параметры

название тип описание
key идентификатор ключа Переместите пользователя, который будет связан с другим ключом. Например, если они обновляются с пробной версии.
identifier строка Обновите идентификатор пользователя.
state строка Обновите состояние пользователя либо на deactivated либо обратно на active .

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

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

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

import ricloud

user = ricloud.User.update_with_id(<user ID>, state='deactivated')

# OR

user = ricloud.User.retrieve(<user ID>)

user.update(state='deactivated')

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

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

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

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

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

Можем ли мы улучшить эту статью?

Нам нравится слышать от пользователей: почему бы не написать нам электронное письмо, оставить комментарий или написать в Твиттере @reincubate?

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