OAuth-приложения#

Окно OAuth-приложения (OAuth Applications) предназначено для управления интеграциями внешних сервисов с платформой по протоколу OAuth 2.0 с помощью следующих операций:

  • регистрация новых OAuth-клиентов и назначение им параметров доступа;

  • генерация и отзыв токенов авторизации для API;

  • контроль активных интеграций и применение политик безопасности для внешних систем.

Для перехода к окну OAuth-приложения (OAuth Applications) выберите на панели навигации Управление доступом ‣ OAuth-приложения (Access Management ‣ OAuth Applications).

Таблица приложений#

Внешний вид окна OAuth-приложения (OAuth Applications) представлен на схеме:

../../../_images/applicaions-index-light.png ../../../_images/applicaions-index-dark.png

Таблица приложений состоит из столбцов согласно настройке с помощью кнопки Настроить столбцы (Manage columns). Полный список столбцов:

  • флаги для выбора нескольких записей;

  • Название (Name) – ссылка для перехода в окно просмотра сведений о приложении;

  • Описание (Description) – краткое описание приложения;

  • Дата создания (Created) – дата и время создания приложения;

  • Последнее изменение (Last Modified) – дата и время последнего изменения приложения;

  • Организация (Organization) – ссылка для перехода в окно просмотра сведений об организации-владельце;

  • кнопки для быстрого вызова часто выполняемых действий:

    • редактирование приложения;

    • удаление приложения.

Просмотр сведений о приложении#

Для получения подробных сведений о приложении нажмите на ссылку с его названием в таблице приложений.

Окно сведений о приложении состоит из следующих вкладок:

  • Подробности (Details) – общие сведения о приложении.

  • Токены (Tokens) – таблица связанных с приложением токенов.

    Таблица токенов состоит из следующих столбцов:

    • флаги для выбора нескольких записей;

    • Название (Name) – ссылка для перехода в окно просмотра сведений о пользователе-владельце токена;

    • Область (Scope) – режим доступа к данным платформы, предоставляемый токеном;

    • Истекает (Expires) – дата и время истечения срока действия токена.

Создание приложения#

Для создания приложения выполните следующие действия:

  1. В окне OAuth-приложения (OAuth Applications) нажмите кнопку Создать OAuth-приложение (Create OAuth application).

  2. Заполните форму Создать OAuth-приложение (Create OAuth application):

    • Название (Name) – укажите название приложения. Название должно быть уникальным в рамках организации.

    • Описание (Description) – укажите описание приложения.

    • Организация (Organization) – выберите организацию-владельца.

    • Тип разрешения (Authorization grant type) – выберите тип доступа к контроллеру.

      Поддерживаются следующие значения:

      • Код авторизации (Authorization code);

      • Пароль (Password).

    • Тип клиента (Client type) – укажите уровень защищенности приложения, которому предоставляете доступ.

      Поддерживаются следующие значения:

      • Конфиденциальный (Confidential) – приложение имеет механизмы защиты доступа к своим данным;

      • Публичный (Public) – данные приложения публично доступны.

    • URI перенаправления (Redirect URIs) – укажите список разрешенных URI. В качестве разделителя используйте символ пробела.

      Примечание

      Это поле обязательно для заполнения, если в поле Тип разрешения (Authorization grant type) выбрано значение Код авторизации (Authorization code).

  3. Нажмите кнопку Создать OAuth-приложение (Create OAuth application).

  4. В открывшемся окне Application information выводятся следующие данные, необходимые для использования приложения:

    • ID клиента (Client ID) – идентификатор клиента.

    • Client secret – секретная фраза клиента. Выводится только если при создании приложения выбран тип клиента «Конфиденциальный».

    Важно

    Сохраните показанные значения в надежном месте – после закрытия диалогового окна получить к ним доступ повторно невозможно.

  5. Создайте токены согласно инструкций, приведенных в секции Создание токена.

Удаление приложения#

Опасно

Вместе с приложением удаляются все связанные с ним токены. Для восстановления доступа приложений к контроллеру все токены нужно будет создать заново.

Чтобы удалить приложения, выполните следующие действия:

  1. В таблице установите флаги в строках с приложениями, которые необходимо удалить.

  2. На панели инструментов нажмите кнопку и в открывшемся меню выберите пункт Удалить OAuth-приложения (Delete OAuth Applications).

  3. Подтвердите удаление.

Удаление токенов приложения#

Предупреждение

При удалении токена использующие его приложения теряют доступ к контроллеру.

Чтобы удалить токен приложения, выполните следующие действия:

  1. В таблице нажмите на название приложения, токен которого необходимо удалить.

  2. Во вкладке Токены (Tokens) включите флаги в строках с удаляемыми токенами.

  3. На панели инструментов нажмите кнопку и в открывшемся меню выберите пункт Удалить токены (Delete tokens).

  4. Подтвердите удаление.