Настроить и использовать Canva API администратора

С помощью Canva Admin API можно автоматизировать управление организацией из собственных систем. Управляйте пользователями, командами, группами и участниками, а также получайте события из журнала аудита — без необходимости выполнять эти задачи вручную в Canva.

• Доступно в тарифах Canva для бизнеса, Canva Districts и Canva для кампуса.
• Доступно администраторам организации.
• Доступно организациям с одной или несколькими командами.

Перед настройкой Admin API убедитесь, что ваша организация соответствует следующим требованиям:

• Уровень организации: Admin API работает на уровне организации. Он доступен организациям с одной или несколькими командами, использующим тарифы Canva для бизнеса, Canva Districts и Canva для кампуса.
• Учетная запись администратора организации: Только администраторы организации могут создавать клиенты Admin API и управлять ими в настройках Canva.
• Собственные или привлеченные инженеры: Для создания и поддержки интеграции вашей организации потребуются инженерные ресурсы. Canva не оказывает помощь во внедрении.
  • Если ваша команда не может работать с API, для автоматизации управления пользователями в организации лучше подойдет подготовка пользователей по SCIM.
• Знание структуры Canva: Прежде чем создавать интеграцию, разберитесь, как в Canva устроены ваша организация, команды и группы.
• Многофакторная аутентификация (MFA) или учетная запись с управлением через единый вход (SSO): У администратора организации, настраивающего Admin API, должна быть включена MFA или учетная запись должна управляться через единый вход (SSO). Учетная запись должна принадлежать организации, от имени которой действует администратор, или управляться ею.

В Admin API доступны конечные точки для:

• Пользователей, команд и групп: создания, просмотра, обновления и удаления.
• Участников: добавления и удаления людей в командах и группах, а также назначения им ролей.
• Журналов аудита: получения событий по расписанию.
• Приглашений в команды: приглашения людей в команду (в том числе за пределами организации), просмотра ожидающих приглашений, получения существующей ссылки-приглашения по точному адресу электронной почты и отмены приглашений.

Администратор организации создает клиент Admin API и использует его для вызовов API.

Следуйте документации по Canva Admin API, чтобы обменять учетные данные клиента на маркер доступа и начать отправлять запросы к API.

Технические сведения об аутентификации запросов к API и использовании токенов предъявителя OAuth 2.0 можно найти в документации по аутентификации в Canva Admin API — поделитесь ею с инженерной командой.

Действия, выполненные через Admin API, записываются за клиентом Admin API, а не за администратором, который его вызвал.

В журналах аудита в поле «Субъект» отображаются название и идентификатор клиента Admin API. Это позволяет определить, какая интеграция выполнила действие.

Также можно определить, какой администратор организации создал, обновил или удалил конкретный клиент API.

Подробнее см. в статье «О журналах аудита Canva».

Администраторы организации могут использовать Admin API, чтобы приглашать людей в команды, в том числе внешних участников, не входящих в организацию.

Важно знать

• Каждое приглашение создается для одной команды и одного адреса электронной почты.
• Приглашение можно использовать один раз; оно истекает через 30 дней.
• В зависимости от настроек Canva может не отправить приглашенному автоматическое письмо. При необходимости отправьте ему ссылку-приглашение напрямую.
• Не передавайте ссылки-приглашения посторонним. Ссылка работает только для адреса электронной почты, для которого она была создана.
• На приглашенных распространяются действующие настройки приглашений и доменов вашей команды.
• Если для приглашенного уже есть ожидающее приглашение, при создании нового будет возвращена та же запись приглашения. Срок действия начнет отсчитываться заново — 30 дней с момента запроса, а роль в приглашении изменится на запрошенную.

Сведения о конечных точках см. в документации по Canva Admin API.

И Admin API, и SCIM можно использовать для подготовки учетных записей пользователей.

Admin API позволяет управлять не только подготовкой учетных записей, но и другими аспектами организации Canva, включая команды, группы, участников и журналы аудита.

SCIM поддерживает стандартную подготовку учетных записей и прекращение доступа. Если вам нужна только стандартная подготовка учетных записей пользователей или ваша команда не может создать собственную интеграцию с API, SCIM лучше подойдет для ваших задач.

Нужен ли моей организации разработчик для использования Admin API?

Да. Для создания и поддержки интеграции вашей организации потребуются собственные или привлеченные инженерные ресурсы. Canva не оказывает помощь во внедрении. Если ваша команда не может работать с API, для автоматизации управления пользователями в организации лучше подойдет подготовка пользователей по SCIM.

Нужны ли всем сотрудникам моей организации MFA или SSO для использования Admin API?

Нет. MFA должна быть включена только у администратора организации, настраивающего Admin API, либо его учетная запись должна управляться через единый вход (SSO). Учетная запись должна принадлежать организации, от имени которой действует администратор, или управляться ею. Для работы Admin API другим участникам организации MFA или SSO не требуются.

Может ли моя организация приглашать внешних участников с помощью Admin API?

Да. Администраторы организации могут использовать Admin API, чтобы приглашать людей в команды, в том числе внешних участников. На приглашенных распространяются действующие настройки приглашений и доменов вашей команды.

Можно ли повторно получить существующую ссылку-приглашение, не создавая новое приглашение?

Да. Существующую ссылку-приглашение можно получить по точному адресу электронной почты приглашенного, не создавая новое приглашение.