Сервис управления сущностями пользователей.
/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 |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public UsersController GroupDelete(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.ListGuidIdApiParam)
Тип схемы безопасности: 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/Update
Обновляет пользователя.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Модель обновления пользователя.
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
id | string (uuid) | Уникальный идентификатор сущности. | нет | |
firstName | string | Имя пользователя. | нет | |
middleName | string | Отчество пользователя. | нет | |
lastName | string | Фамилия пользователя. | нет | |
userName | string | Имя пользователя (логин). | нет | |
string | Email. | нет | ||
phoneNumber | string (tel) | Телефонный номер. | нет | |
lockoutEnabled | boolean | Флаг, разрешающий возможность блокировки пользователя при нескольких ошибочных вводах учётных данных. | да | |
nonEditable | boolean | Запрещено редактирование. | нет | |
lockReason | string | Причина блокировки. | нет | |
deprecatePasswordExpiring | boolean | Пароль не имеет срока давности. | нет |
Возвращаемые результаты
Код 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 Update(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Users.UpdateUserApiParam)
Тип схемы безопасности: 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/SetPassword
Задает пароль пользователя.
Не требует указания старого пароля.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Модель установки пароля пользователя.
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
userId | string (uuid) | Идентификатор пользователя. | нет | |
password | string | Новый пароль. | да | |
confirmPassword | string | Подтверждение пароля. | да | |
expirationDays | integer (int32) | Срок действия первичного пароля. | нет | |
requireChangeOnFirstLogin | boolean | Признак того, что пароль необходимо сменить после первого входа. | нет |
Возвращаемые результаты
Код 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 SetPassword(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Users.SetPasswordApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
Название | Значение |
---|---|
Тип | authorizationCode |
Авторизация | /identity/connect/authorize |
Выдача токена | /identity/connect/token |
Обновление | |
Области разрешений доступа | identityadminapi:user:changepassword |
/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/ChangePassword
Изменяет пароль пользователя.
Требует указания старого пароля.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Модель изменения пароля пользователя.
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
userId | string (uuid) | Идентификатор пользователя. | нет | |
oldPassword | string | Старый пароль. | да | |
newPassword | string | Новый пароль. | да | |
confirmNewPassword | string | Подтверждение пароля. | да | |
providerName | string | Название провайдера аутентификация, для которого проивзодится изменение пароля. | нет | |
syncPasswordWithProviders | boolean | Флаг, указывающий на необходимость синхронизировать пароль с провайдерами. | нет |
Возвращаемые результаты
Код 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 ChangePassword(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Users.ChangePasswordApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
Название | Значение |
---|---|
Тип | authorizationCode |
Авторизация | /identity/connect/authorize |
Выдача токена | /identity/connect/token |
Обновление | |
Области разрешений доступа | identityadminapi:user:changepassword |
/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/IsUserChangedInitialPassword
Возвращает результат проверки, был ли изменён первоначальный пароль пользователя.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Уникальный идентификатор пользователя.
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
id | string (uuid) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
result | boolean | Данные результата метода API. | да | |
error | Info | да | ||
typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public UsersController IsUserChangedInitialPassword(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/UserFailedToLogin
Сохраняет информацию о неудачной попытке пользователя войти в систему.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Информация о неудачном логине пользователя.
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
login | string | Логин. | да | |
errorCode | string | Код ошибки. | нет | |
errorMessage | string | Текст ошибки. | нет | |
providerName | string | Имя провайдера аутентификации. | да | |
ipAddress | string | IP-адрес пользователя, с которого произошла попытка входа в систему. | нет | |
ldapDomainId | integer (int32) | Идентификатор домена LDAP. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
result | UserFailedToLoginResult | да | ||
error | Info | да | ||
typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public UsersController UserFailedToLogin(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Users.UserLoginFailedApiParam)
Тип схемы безопасности: 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/GetRoles
Возвращает список ролей пользователя.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Уникальный идентификатор пользователя.
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
id | string (uuid) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
result | UserRolesResult | да | ||
error | Info | да | ||
typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public UsersController GetRoles(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/AddToRole
Добавляет пользователю роль.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметр добавления роли пользователю:
UserId - уникальный идентификатор пользователя,
RoleId - уникальный идентификатор роли.
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
userId | string (uuid) | Уникальный идентификатор пользователя. | да | |
roleId | string (uuid) | Уникальный идентификатор роли. | да |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
result | UserRolesResult | да | ||
error | Info | да | ||
typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public UsersController AddToRole(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Users.UserRoleApiParam)
Тип схемы безопасности: 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/DeleteFromRole
Удаляет роль у пользователя.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметр удаления роли у пользователя:
UserId - уникальный идентификатор пользователя,
RoleId - уникальный идентификатор роли.
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
userId | string (uuid) | Уникальный идентификатор пользователя. | да | |
roleId | 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 DeleteFromRole(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Users.UserRoleApiParam)
Тип схемы безопасности: 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/LockUser
Блокирует пользователя.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор пользователя.
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
userId | string (uuid) | Уникальный идентификатор пользователя. | да | |
lockReason | string | Причина блокировки. | нет |
Возвращаемые результаты
Код 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 LockUser(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Users.LockUserApiParam)
Тип схемы безопасности: 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/UnlockUser
Снимает блокировку с пользователя.
Тип 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 UnlockUser(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/GroupLock
Блокирует список пользователей.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Список идентификаторов пользователей.
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
idParams | GuidIdApiParam[] | Список идентификаторов. | нет |
Возвращаемые результаты
Код 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 GroupLock(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.ListGuidIdApiParam)
Тип схемы безопасности: 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/GroupUnlock
Снимает блокировку со списка пользователей.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Список идентификаторов пользователей.
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
idParams | GuidIdApiParam[] | Список идентификаторов. | нет |
Возвращаемые результаты
Код 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 GroupUnlock(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.ListGuidIdApiParam)
Тип схемы безопасности: 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/Claims/GetAll
Возвращает все утверждения (claims), связанные с пользователем.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметр с System.Guid идентификатором пользователя.
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
id | string (uuid) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
result | UserClaimsResult | да | ||
error | Info | да | ||
typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public UsersController GetAllClaims(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/Claims/Create
Создаёт новое утверждение (claim), связанное с пользователем.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Модель добавления утверждения (claim) пользователя на основе System.Guid идентификатора.
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
claimOwnerId | string (uuid) | Идентификатор сущности, для которой добавляется Claim. | да | |
type | string | Тип сущности. | да | |
value | string | Значение сущности. | да |
Возвращаемые результаты
Код 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 CreateClaim(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Claims.AddClaimApiParam`1[[System.Guid, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]])
Тип схемы безопасности: 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/Claims/Delete
Удаляет утверждение (claim), связанное с пользователем.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Модель удаления утверждения (claim) пользователя на основе идентификатора.
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
id | integer (int32) | Уникальный идентификатор сущности. | да | |
claimOwnerId | string (uuid) | Идентификатор пользователя для Claim. | да |
Возвращаемые результаты
Код 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 DeleteClaim(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Claims.DeleteClaimApiParam)
Тип схемы безопасности: 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/Claims/Update
Обновляет утверждение (claim), связанное с пользователем.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Модель обновления утверждения (claim) пользователя на основе System.Guid идентификатора.
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
id | integer (int32) | Уникальный идентификатор сущности. | да | |
claimOwnerId | string (uuid) | Идентификатор сущности, для которой обновляется Claim. | да | |
type | string | Тип сущности. | нет | |
value | string | Значение сущности. | нет |
Возвращаемые результаты
Код 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 UpdateClaim(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Claims.UpdateClaimApiParam`1[[System.Guid, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]])
Тип схемы безопасности: 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/Providers/GetAll
Возвращает список внешних провайдеров, подключённых к пользователю.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Уникальный идентификатор пользователя.
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
id | string (uuid) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
result | UserProvidersResult | да | ||
error | Info | да | ||
typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public UsersController GetAllProviders(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 |