Платформа 3V/Планировщик/Настройки аутентификации: различия между версиями

Материал из 3v-wiki
Перейти к навигации Перейти к поиску
Строка 36: Строка 36:
  
 
== Метод Edit ==
 
== Метод Edit ==
 +
Обновляет существующие настройки аутентификации.<br>
 +
Параметры:
 +
*'''newSettings''' - новые значения настроек.
 +
 +
Значения настроек - JSON вида:
 +
<syntaxhighlight lang="JSON">
 +
{
 +
"settings": {
 +
"tokenRequestUrl": "https://3v.3v-group.net/auth/realms/trivium/protocol/openid-connect/token",
 +
"clientId": "test-client",
 +
"clientSecret": "some-client-UUID"
 +
},
 +
"id": 6,
 +
"name": "test"
 +
}
 +
</syntaxhighlight>
 +
*'''tokenRequestUrl''' - урл по которому можно запросить токен.
 +
*'''clientId''' - идентификатор клиента для которого запрашиваем токен.
 +
*'''clientSecret''' - секрет клиента для которого запрашиваем токен.
 +
*'''id''' - идентификатор настроек.
 +
*'''name''' - наименование настроек.
  
 
== Метод Delete==
 
== Метод Delete==

Версия 12:53, 7 октября 2020

Планировщик позволяет выполнять задачи, требующие авторизации через OAuth2

Для настроек аутентификации в сервисе планировщика имеется отдельный контроллер 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"
}
  • tokenRequestUrl - урл по которому можно запросить токен.
  • clientId - идентификатор клиента для которого запрашиваем токен.
  • clientSecret - секрет клиента для которого запрашиваем токен.

Метод GetById

Возвращает настройки аутентификации по их идентификатору, или null, если нет настроек с таким идентификатором.
Параметры:

  • authenticationSettingsId - идентификатор настроек.

Метод GetByName

Возвращает список настроек аутентификации с указанным именем.
Параметры:

  • authenticationSettingsName - имя настроек.

Метод GetAll

Возвращает все настройки аутентификации для всех задач планировщика.

Метод Edit

Обновляет существующие настройки аутентификации.
Параметры:

  • newSettings - новые значения настроек.

Значения настроек - JSON вида: 

{
	"settings": {
		"tokenRequestUrl": "https://3v.3v-group.net/auth/realms/trivium/protocol/openid-connect/token",
		"clientId": "test-client",
		"clientSecret": "some-client-UUID"
	},
	"id": 6,
	"name": "test"
}
  • tokenRequestUrl - урл по которому можно запросить токен.
  • clientId - идентификатор клиента для которого запрашиваем токен.
  • clientSecret - секрет клиента для которого запрашиваем токен.
  • id - идентификатор настроек.
  • name - наименование настроек.

Метод Delete

Источник — https://wiki.3v-group.net/index.php?title=Платформа_3V/Планировщик/Настройки_аутентификации&oldid=89