Настройки аутентификации

Материал из 3v-wiki
Перейти к навигации Перейти к поиску

Планировщик позволяет выполнять задачи, требующие авторизации через OAuth2
Перейти в Планировщик можно по ссылке https://*******/scheduler/swagger/index.html#/ например, для cloud это https://api.3v-cloud.com/scheduler/swagger/index.html#/ Настройка аутентификации производится в разделе Authentication.

Раздел планировщика аутентификация.png



Метод 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 - идентификатор настроек.