Перейти к основному содержимому

Сервис управления сущностями пользователей.

/api/Users/GetAll

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

Тип HTTP запроса: post

Отсылаемый запрос

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultUserInfoResult[]Данные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код 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.

Название поляТип поляОписаниеОбязательноеВозможные значения
idstring (uuid)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultUserInfoResultда
errorInfoда
typeInfoTypeInfo

Код 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

Название поляТип поляОписаниеОбязательноеВозможные значения
userNamestringИмя (логин) пользователя.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultUserInfoResultда
errorInfoда
typeInfoTypeInfo

Код 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) и значениями.

Название поляТип поляОписаниеОбязательноеВозможные значения
conditionsSearchUserConditionApiParam[]Условия поиска.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultUserInfoResult[]Данные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код 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

Модель создания пользователя.

Название поляТип поляОписаниеОбязательноеВозможные значения
firstNamestringИмя пользователя.нет
middleNamestringОтчество пользователя.нет
lastNamestringФамилия пользователя.нет
userNamestringИмя пользователя (логин).да
emailstringEmail.да
phoneNumberstring (tel)Телефонный номер.нет
lockoutEnabledbooleanФлаг, разрешающий возможность блокировки пользователя при нескольких ошибочных вводах учётных данных.нет
nonEditablebooleanЗапрещено редактирование.нет
lockReasonstringПричина блокировки.нет
passwordstringПервичный пароль.нет
expirationDaysinteger (int32)Срок действия первичного пароля.нет
requireChangeOnFirstLoginbooleanФлаг, задающий требование сменить пароль при первой аутентификации.нет
deprecatePasswordExpiringbooleanФлаг, указывающий, что пароль пользователя не имеет срока давности.нет

Возвращаемые результаты

Код HTTP ответа: 201

MIME-тип HTTP ответа: application/json

Created

Название поляТип поляОписаниеОбязательноеВозможные значения
resultUserInfoResultда
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 400

MIME-тип HTTP ответа: application/json

Bad Request

Название поляТип поляОписаниеОбязательноеВозможные значения
typestringнет
titlestringнет
statusinteger (int32)нет
detailstringнет
instancestringнет

Код 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

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

Название поляТип поляОписаниеОбязательноеВозможные значения
idstring (uuid)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код 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

Список идентификаторов удаляемых пользователей.

Название поляТип поляОписаниеОбязательноеВозможные значения
idParamsGuidIdApiParam[]Список идентификаторов.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код 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

Модель обновления пользователя.

Название поляТип поляОписаниеОбязательноеВозможные значения
idstring (uuid)Уникальный идентификатор сущности.нет
firstNamestringИмя пользователя.нет
middleNamestringОтчество пользователя.нет
lastNamestringФамилия пользователя.нет
userNamestringИмя пользователя (логин).нет
emailstringEmail.нет
phoneNumberstring (tel)Телефонный номер.нет
lockoutEnabledbooleanФлаг, разрешающий возможность блокировки пользователя при нескольких ошибочных вводах учётных данных.да
nonEditablebooleanЗапрещено редактирование.нет
lockReasonstringПричина блокировки.нет
deprecatePasswordExpiringbooleanПароль не имеет срока давности.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultUserInfoResultда
errorInfoда
typeInfoTypeInfo

Код 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

Модель установки пароля пользователя.

Название поляТип поляОписаниеОбязательноеВозможные значения
userIdstring (uuid)Идентификатор пользователя.нет
passwordstringНовый пароль.да
confirmPasswordstringПодтверждение пароля.да
expirationDaysinteger (int32)Срок действия первичного пароля.нет
requireChangeOnFirstLoginbooleanПризнак того, что пароль необходимо сменить после первого входа.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код 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

Модель изменения пароля пользователя.

Название поляТип поляОписаниеОбязательноеВозможные значения
userIdstring (uuid)Идентификатор пользователя.нет
oldPasswordstringСтарый пароль.да
newPasswordstringНовый пароль.да
confirmNewPasswordstringПодтверждение пароля.да
providerNamestringНазвание провайдера аутентификация, для которого проивзодится изменение пароля.нет
syncPasswordWithProvidersbooleanФлаг, указывающий на необходимость синхронизировать пароль с провайдерами.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код 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

Уникальный идентификатор пользователя.

Название поляТип поляОписаниеОбязательноеВозможные значения
idstring (uuid)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultbooleanДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код 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

Информация о неудачном логине пользователя.

Название поляТип поляОписаниеОбязательноеВозможные значения
loginstringЛогин.да
errorCodestringКод ошибки.нет
errorMessagestringТекст ошибки.нет
providerNamestringИмя провайдера аутентификации.да
ipAddressstringIP-адрес пользователя, с которого произошла попытка входа в систему.нет
ldapDomainIdinteger (int32)Идентификатор домена LDAP.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultUserFailedToLoginResultда
errorInfoда
typeInfoTypeInfo

Код 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

Уникальный идентификатор пользователя.

Название поляТип поляОписаниеОбязательноеВозможные значения
idstring (uuid)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultUserRolesResultда
errorInfoда
typeInfoTypeInfo

Код 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 - уникальный идентификатор роли.

Название поляТип поляОписаниеОбязательноеВозможные значения
userIdstring (uuid)Уникальный идентификатор пользователя.да
roleIdstring (uuid)Уникальный идентификатор роли.да

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultUserRolesResultда
errorInfoда
typeInfoTypeInfo

Код 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 - уникальный идентификатор роли.

Название поляТип поляОписаниеОбязательноеВозможные значения
userIdstring (uuid)Уникальный идентификатор пользователя.да
roleIdstring (uuid)Уникальный идентификатор роли.да

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код 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

Идентификатор пользователя.

Название поляТип поляОписаниеОбязательноеВозможные значения
userIdstring (uuid)Уникальный идентификатор пользователя.да
lockReasonstringПричина блокировки.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код 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

Идентификатор пользователя.

Название поляТип поляОписаниеОбязательноеВозможные значения
idstring (uuid)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код 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

Список идентификаторов пользователей.

Название поляТип поляОписаниеОбязательноеВозможные значения
idParamsGuidIdApiParam[]Список идентификаторов.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код 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

Список идентификаторов пользователей.

Название поляТип поляОписаниеОбязательноеВозможные значения
idParamsGuidIdApiParam[]Список идентификаторов.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код 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 идентификатором пользователя.

Название поляТип поляОписаниеОбязательноеВозможные значения
idstring (uuid)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultUserClaimsResultда
errorInfoда
typeInfoTypeInfo

Код 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 идентификатора.

Название поляТип поляОписаниеОбязательноеВозможные значения
claimOwnerIdstring (uuid)Идентификатор сущности, для которой добавляется Claim.да
typestringТип сущности.да
valuestringЗначение сущности.да

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код 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) пользователя на основе идентификатора.

Название поляТип поляОписаниеОбязательноеВозможные значения
idinteger (int32)Уникальный идентификатор сущности.да
claimOwnerIdstring (uuid)Идентификатор пользователя для Claim.да

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код 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 идентификатора.

Название поляТип поляОписаниеОбязательноеВозможные значения
idinteger (int32)Уникальный идентификатор сущности.да
claimOwnerIdstring (uuid)Идентификатор сущности, для которой обновляется Claim.да
typestringТип сущности.нет
valuestringЗначение сущности.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код 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

Уникальный идентификатор пользователя.

Название поляТип поляОписаниеОбязательноеВозможные значения
idstring (uuid)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultUserProvidersResultда
errorInfoда
typeInfoTypeInfo

Код 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