Сервис управления сущностями пользователей.
/api/Users/GetAll
Получает список всех пользователей.
Тип HTTP запроса: post
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | UserInfoResult[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public UsersController GetAll()
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:user:read |
/components/securitySchemes/identityadminapi
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:user:changepassword, identityadminapi:user:read, identityadminapi:user:write |
/api/Users/GetOne
Получает пользователя по идентификатору.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Модель с идентификатором пользователя типа System.Guid.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | UserInfoResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public UsersController GetOne(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.GuidIdApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:user:read |
/components/securitySchemes/identityadminapi
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:user:changepassword, identityadminapi:user:read, identityadminapi:user:write |
/api/Users/GetOneByLogin
Возвращает информацию о пользователе по логину (username).
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| userName | string | Имя (логин) пользов ателя. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | UserInfoResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public UsersController GetOneByLogin(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Users.UserNameApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Н азвание | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:user:read |
/components/securitySchemes/identityadminapi
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:user:changepassword, identityadminapi:user:read, identityadminapi:user:write |
/api/Users/Find
Поиск пользователей по условиям.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Список условий с ключами (FirstName, MiddleName, LastName, ExternalCode, Email, UserName) и значениями.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| conditions | SearchUserConditionApiParam[] | Условия поиска. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | UserInfoResult[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public UsersController FindUsers(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Users.SearchUserApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:user:read |
/components/securitySchemes/identityadminapi
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:user:changepassword, identityadminapi:user:read, identityadminapi:user:write |
/api/Users/Create
Создаёт пользователя.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Модель создания пользователя.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| firstName | string | Имя пользователя. | нет | |
| middleName | string | Отчество пользователя. | нет | |
| lastName | string | Фамилия пользователя. | нет | |
| userName | string | Имя пользователя (логин). | да | |
| string | Email. | да | ||
| phoneNumber | string (tel) | Телефонный номер. | нет | |
| lockoutEnabled | boolean | Флаг, разрешающий возможность блокировки пользователя при нескольких ошибочных вводах учётных данных. | нет | |
| nonEditable | boolean | Запрещено редактирование. | нет | |
| lockReason | string | Причина блокировки. | нет | |
| password | string | Первичный пароль. | нет | |
| expirationDays | integer (int32) | Срок действия первичного пароля. | нет | |
| requireChangeOnFirstLogin | boolean | Флаг, задающий требование сменить пароль при первой аутентификации. | нет | |
| deprecatePasswordExpiring | boolean | Флаг, указывающий, что пароль пользователя не имеет срока давности. | нет |
Возвращаемые результаты
Код HTTP ответа: 201
MIME-тип HTTP ответа: application/json
Created
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | UserInfoResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 400
MIME-тип HTTP ответа: application/json
Bad Request
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| type | string | нет | ||
| title | string | нет | ||
| status | integer (int32) | нет | ||
| detail | string | нет | ||
| instance | string | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public UsersController Create(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Users.AddUserApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:user:write |
/components/securitySchemes/identityadminapi
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:user:changepassword, identityadminapi:user:read, identityadminapi:user:write |
/api/Users/Delete
Удаляет пользователя.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметр с идентификатором пользователя.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public UsersController Delete(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.GuidIdApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:user:write |
/components/securitySchemes/identityadminapi
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:user:changepassword, identityadminapi:user:read, identityadminapi:user:write |
/api/Users/GroupDelete
Удаление указанного списка пользователей. Возможно удаление максимум 10 пользователей в одном запросе.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Список идентификаторов удаляемых пользователей.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| idParams | GuidIdApiParam[] | Список идентификаторов. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |