Платформа 3V/Планировщик/Настройки аутентификации: различия между версиями
Строка 1: | Строка 1: | ||
{{DISPLAYTITLE:Настройки аутентификации}} | {{DISPLAYTITLE:Настройки аутентификации}} | ||
− | |||
Планировщик позволяет выполнять задачи, требующие авторизации через [https://ru.wikipedia.org/wiki/OAuth OAuth2]<br> | Планировщик позволяет выполнять задачи, требующие авторизации через [https://ru.wikipedia.org/wiki/OAuth OAuth2]<br> | ||
− | |||
Перейти в Планировщик можно по ссылке https://*******/scheduler/swagger/index.html#/ например, для cloud это https://api.3v-cloud.com/scheduler/swagger/index.html#/ | Перейти в Планировщик можно по ссылке https://*******/scheduler/swagger/index.html#/ например, для cloud это https://api.3v-cloud.com/scheduler/swagger/index.html#/ | ||
− | Настройка аутентификации производится в разделе '''Authentication''' | + | Настройка аутентификации производится в разделе '''Authentication'''. |
− | [[Файл:Раздел планировщика аутентификация.png| | + | [[Файл:Раздел планировщика аутентификация.png|500px|слева]]<br clear="both" /><br> |
== Метод Add == | == Метод Add == | ||
Добавляет новые настройки аутентификации, возвращает идентификатор добавленных настроек.<br> | Добавляет новые настройки аутентификации, возвращает идентификатор добавленных настроек.<br> |
Версия 07:56, 22 декабря 2021
Планировщик позволяет выполнять задачи, требующие авторизации через OAuth2
Перейти в Планировщик можно по ссылке https://*******/scheduler/swagger/index.html#/ например, для cloud это https://api.3v-cloud.com/scheduler/swagger/index.html#/
Настройка аутентификации производится в разделе Authentication.
Метод Add
Добавляет новые настройки аутентификации, возвращает идентификатор добавленных настроек.
Параметры:
- name - имя добавляемых настроек.
- settings - настройки аутентификации.
Настройки аутентификации - JSON вида:
{
"tokenRequestUrl": "https://3v.3v-group.net/auth/realms/trivium/protocol/openid-connect/token",
"clientId": "test-client",
"clientSecret": "some-client-UUID",
"discriminator": "ConfidentialClientAuthenticationSettingsDto"
}
- tokenRequestUrl - урл по которому можно запросить токен.
- clientId - идентификатор клиента для которого запрашиваем токен.
- clientSecret - секрет клиента для которого запрашиваем токен.
Как настроить конфиденциального клиента на примере Keycloack
Метод GetById
Возвращает настройки аутентификации по их идентификатору, или null, если нет настроек с таким идентификатором.
Параметры:
- authenticationSettingsId - идентификатор настроек.
Метод GetByName
Возвращает список настроек аутентификации с указанным именем.
Параметры:
- authenticationSettingsName - имя настроек.
Метод GetAll
Возвращает все настройки аутентификации для всех задач планировщика.
Метод Edit
Обновляет существующие настройки аутентификации.
Параметры:
- newSettings - новые значения настроек.
Значения настроек - JSON вида:
{
"settings": {
"tokenRequestUrl": "https://.../auth/realms/trivium/protocol/openid-connect/token",
"clientId": "test-client",
"clientSecret": "some-client-UUID"
},
"id": 6,
"name": "test"
}
- tokenRequestUrl - урл по которому можно запросить токен.
- clientId - идентификатор клиента для которого запрашиваем токен.
- clientSecret - секрет клиента для которого запрашиваем токен.
- id - идентификатор настроек.
- name - наименование настроек.
Метод Delete
Удаляет настройки аутентификации по их идентификатору.
Параметры:
- authenticationSettingsId - идентификатор настроек.