Интеллектуальные возможности > Сервисы Directum Ario > Описание API Ario

В разделе описаны запросы, которые используются только в случае, если в настройках сервиса Directum Smart Service задан запрет на анонимную работу:

в конфигурационном файле appsetting.json параметр AllowAnonymousAccess принимает значение False;

в конфигурационном файле .env в секции Smart Service параметр dss_allow_anonymous_access принимает значение False.

Запрос	Описание
Просмотр списка учетных записей	Запрос для отображения списка всех учетных записей
Создание новой учетной записи	Запрос для создания новой учетной записи
Сброс пароля учетной записи	Запрос для сброса пароля учетной записи
Изменение пароля учетной записи	Запрос для изменения пароля своей учетной записи
Изменение состояния учетной записи	Запрос для изменения состояния учетной записи. Например, чтобы заблокировать неактуальную учетную запись
Получение токена	Запрос для получения токена доступа. Токен используется во всех запросах, если запрещена анонимная работа с сервисами Ario

Получить список учетных записей

Синтаксис

GET {{service_url}}/api/identity/clients

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

GET http://smart:61100/api/identity/clients

Ответ

Содержит список всех учетных записей:

[
{
"clientId": "admin",
"enabled": true,
"canPublish": true,
"created": "2023-12-06T12:21:24.376869"
},
{...},
...
]

Где:

•clientId – имя пользователя;

•enabled – статус учетной записи. Возможные значения: true – действующая (активная), false – недействующая (неактивная);

•canPublish – признак того, что пользователь может публиковать прикладную разработку. Возможные значения: true, false;

•created – дата и время создания учетной записи.

Создать новую учетную запись

Синтаксис

POST {{service_url}}/api/identity/client

{
"clientId": "Имя пользователя",
"clientSecret": "Пароль пользователя",
"canPublish": "Возможность публикации прикладной разработки"
}

Параметры

•clientId – имя пользователя;

•clientSecret – пароль пользователя;

•canPublish – признак того, что пользователь может публиковать прикладную разработку. Возможные значения: true, false.

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

POST http://smart:61100/api/identity/client

{
"clientId": "Snigirev_AV",
"clientSecret": "123456",
"canPublish": "false"
}

Ответ

Содержит основную информацию об учетной записи:

{
"clientId": "snigirev_av",
"enabled": true,
"canPublish": false,
"created": "2023-12-10T09:13:52.4217017Z"
}

Где:

•clientId – имя пользователя из запроса;

•enabled – статус учетной записи. Возможные значения: true – действующая (активная), false – недействующая (неактивная). По умолчанию принимает значение true;

•canPublish – признак того, что пользователь может публиковать прикладную разработку. Возможные значения: true, false. Значение параметра берется из запроса;

•created – дата и время создания учетной записи.

Сбросить пароль учетной записи

Запрос использует в случаях, когда необходимо сменить пароль от указанной учетной записи.

Синтаксис

POST {{service_url}}/api/identity/client/password/reset
{
"clientId": "Имя пользователя",
"clientSecret": "Пароль пользователя"
}

Параметры

•clientId – имя пользователя;

•clientSecret – пароль пользователя.

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

POST http://smart:61100/api/identity/client/password/reset

{
"clientId": "Snigirev_AV",
"clientSecret": "123456"
}

Ответ

У учетной записи меняется пароль на указанный в запросе.

Изменить пароль своей учетной записи

Запрос используется в случае, когда нужно сменить свой пароль от учетной записи

Синтаксис

POST {{service_url}}/api/identity/client/password/change
{
"newClientSecret": "Новый пароль пользователя"
}

Параметры

•newClientSecret – новый пароль пользователя.

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

POST http://smart:61100/api/identity/client/password/change
{
"newClientSecret": "654321"
}

Ответ

У текущей учетной записи меняется пароль на указанный в запросе.

Изменить состояние учетной записи

Запрос используется в случае, когда учетная запись не используется и ее нужно закрыть.

Синтаксис

POST {{service_url}}/api/identity/client/state

{
"clientId": "Имя пользователя",
"clientEnabled": "Пароль пользователя"
}

Параметры

•clientId – имя пользователя;

•clientEnabled – статус учетной записи. Возможные значения: True – действующая (активная), False – недействующая (неактивная);

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

POST http://smart:61100/api/identity/state

{
"clientId": "Snigirev_AV",
"clientEnabled": "True"
}

Ответ

Указанная учетная запись меняет свой статус в зависимости от указанного в запросе параметра clientEnabled.

Получить токен

В разделе описан запрос на получение токена администратора сервисов Directum Ario/

Синтаксис

POST {{service_url}}/api/identity/token

{
"clientId": "Имя пользователя",
"clientSecret": "Пароль пользователя"
}

Параметры

•clientId – имя пользователя;

•clientSecret – пароль пользователя.

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

POST http://smart:61100/api/identity/token

{
"clientId": "Snigirev_AV",
"clientSecret": "123456"
}

Ответ

Содержит информацию о выданном токене:

{
"access_token": "jAfgxaHnDa5Hcp64q0JxFwB3_UvVMVsWDY0tOwTt1u7YiGuHF9Noe9",
"expires_in": "86400
}

Где:

•access_token – токен доступа. Полученный токен требуется для выполнения всех запросов;

•expires_in – время жизни токена в секундах. По истечению этого времени для последующей отправки запросов требуется заново запросить токен.