API управления администраторами

API для управления администраторами в MULTIFACTOR.

Доступ к API

Перед использованием данного API необходимо включить расширенное API в личном кабинете, в разделе "Настройки API" и использовать API Key и API Secret, предоставленные в разделе.

Аутентификация

Заголовок Authorization со значением Basic apikey:apisecret.

Операции

Доступные роли: Admin, Support 1, Support 2, Support 3, Support 4

Доступные статусы: Pending, Active, Locked, TemporaryLocked

Список администраторов

ℹ️ Поддерживается фильтрация по identity и пагинация (offset, limit).

ℹ️ Возможные значения поля status: Pending, Active, Locked, TemporaryLocked.

Адрес https://api.multifactor.ru/admins | метод GET.

Пример запроса:

curl --request GET \
  --user "apikey:apisecret"
  --url 'https://api.multifactor.dev/v1/admins' \
  --header 'Content-Type: application/json'

Пример ответа:

{
  "data": [
    {
      "id": "string",
      "identity": "string",
      "name": "string",
      "status": "string",
      "roles": [
        "Admin"
      ],
      "registrationDate": "2025-01-20T06:47:48.512Z",
      "lastLoginDate": "2025-01-27T07:50:06.218Z"
    }
  ],
  "offset": 0,
  "limit": 200,
  "totalElements": 1
}

Для поиска конкретного администратора по логину используйте параметр запроса Identity:

GET https://api.multifactor.ru/admins?identity=5348bg02395s762821b4adc8

Пример ответа:

{
  "id": "38566658t82d62m6546546tu",
  "identity": "2@mail.ru",
  "name": "44",
  "status": "Pending",
  "roles": [Admin],
  "registrationDate": "2025-01-22T15:48:40.158Z"
}

Регистрация администратора

Адрес https://api.multifactor.ru/admins | метод POST.

ℹ️ Указанный email будет использован в качестве identity. Если админ с указанным email уже содержится, API вернет ошибку 403.

Пример запроса:

curl --request POST \
  --user "apikey:apisecret"
  --url 'https://api.multifactor.dev/v1/admins' \
  --header 'Content-Type: application/json' \
  --data '{
	"email": "valid@email.addr",
	"name": "Admin Name",
	"role": "Admin"
}'

Пример ответа: 

{
  "id": "string",
  "identity": "valid@email.addr",
  "name": "Admin Name",
  "status": "Pending",
  "registrationDate": "string",
  "lastLoginDate": "string",
  "appRoles": [
    "Admin"
  ]
}

Изменение данных администратора

Адрес https://api.multifactor.ru/users/{id} | метод PUT.

• Параметр id — идентификатор пользователя.

Используется для изменении данных, блокировки и разблокировки пользователя.

Пример запроса:

curl --request PUT \
  --user "apikey:apisecret"
  --url 'https://api.multifactor.dev/v1/admins/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
	"name": "Новое имя",
	"role": "Новая роль"
}'

Успешный ответ:

200 OK

Удаление администратора

Адрес https://api.multifactor.ru/users/{id} | метод DELETE.

• Параметр id — идентификатор пользователя.

Пример запроса:

curl --request DELETE \
  --user "apikey:apisecret"
  --url 'https://api.multifactor.dev/v1/admins/{id}' \
  --header 'Content-Type: application/json'

Успешный ответ:

200 OK

Ответ при попытке удалить последнего активного админа:

{
	"message": "Cannot change role of last scope admin.",
	"traceId": "8f10bcb4-8a62-4589-a43a-24cd13d72e3b"
}

Ответ при попытке указать несуществующую роль:

{
	"message": "Unknown role.",
	"traceId": "8f10bcb4-8a62-4589-a43a-24cd13d72e3b"
}

Блокировка администратора

Адрес https://api.multifactor.ru/admins/lock/ID | метод POST.

• Параметр id — идентификатор пользователя.

Функция для генерации и отправки на email пользователя ссылки для настройки второго фактора. Если не указать параметр Email, ссылка будет сгенерирована без отправки письма пользователю и возвращена в ответе сервера.

Пример запроса:

curl --request POST \
  --user "apikey:apisecret"
  --url 'https://api.multifactor.dev/v1/admins/lock/{id}' \
  --header 'Content-Type: application/json'

Успешный ответ:

200 OK

Ответ при попытке заблокировать последнего активного админа:

Разблокирование администратора

Адрес https://api.multifactor.ru/admins/unlock/ID | метод POST.

Пример запроса:

curl --request POST \
  --user "apikey:apisecret"
  --url 'https://api.multifactor.dev/v1/admins/unlock/{id}' \
  --header 'Content-Type: application/json'

Успешный ответ:

200 OK

Ответ при попытке разблокировать администратора в неподходящем статусе:

{
	"message": "Cannot unlock. Admin should be in one of the following states: Locked, TemporaryLocked",
	"traceId": "8f10bcb4-8a62-4589-a43a-24cd13d72e3b"
}

Отправка ссылки на регистрацию второго фактора

Адрес https://api.multifactor.ru/admins/resend-invitation-email | метод POST.

Пример запроса V1:

curl --request POST \
  --user "apikey:apisecret"
  --url 'https://api.multifactor.dev/v1/admins/resend-invitation-email?id={id}' \
  --header 'Content-Type: application/json'

Пример запроса V2:

curl --request POST \
  --user "apikey:apisecret"
  --url 'https://api.multifactor.dev/v2/admins/resend-invitation-email/{id}' \
  --header 'Content-Type: application/json'