Сервис управления сущностями пользователей.
/services/identityadminapi/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
/services/identityadminapi/api/Users/GetOne
Возвращает информацию о пользователе по идентификатору.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Уникальный идентификатор пользователя.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/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
/services/identityadminapi/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
/services/identityadminapi/api/Users/Create
Добавляет нового пользователя.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры добавления нового пользователя:
FirstName - имя пользователя,
LastName - фамилия пользователя,
UserName - логин пользователя,
Email - email пользователя,
PhoneNumber - телефонный номер пользователя.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| firstName | string | Имя пользователя. | нет | |
| middleName | string | Отчество пользователя. | нет | |
| lastName | string | Фамилия пользователя. | нет | |
| userName | string | Имя пользователя (логин). | да | |
| string | Email. | да | ||
| phoneNumber | string (tel) | Телефонный номер. | нет | |
| lockoutEnabled | boolean | Флаг, разре шающий возможность блокировки пользователя при нескольких ошибочных вводах учётных данных. | нет | |
| nonEditable | boolean | Запрещено редактирование. | нет | |
| lockReason | string | Причина блокировки. | нет | |
| password | string | Первичный пароль. | нет | |
| expirationDays | integer (int32) | Срок действия первичного пароля. | нет | |
| 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
/services/identityadminapi/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
/services/identityadminapi/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
/services/identityadminapi/api/Users/Update
Обновляет данные о пользователе.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры для обновления пользователя:
Id - уникальный идентификатор,
FirstName - имя,
LastName - фамилия,
UserName - логин,
Email - email,
PhoneNumber - телефонный номер.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/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
/services/identityadminapi/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
/services/identityadminapi/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
/services/identityadminapi/api/Users/SynchronizeDataWithProvider
Синхронизирует данные пользователя.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры синхронизации: идентификатор пользователя и внешний провайдер.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| providerName | string | Имя провайдера аутентификации. | да | |
| id | string (uuid) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 201
MIME-тип HTTP ответа: application/json
Created
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | UserProvidersResult | да | ||
| 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
/services/identityadminapi/api/Users/SynchronizePasswordWithProvider
Синхронизирует пароль пользователя.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры синхрони зации: идентификатор пользователя и внешний провайдер.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| providerName | string | Имя провайдера аутентификации. | да | |
| id | string (uuid) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 201
MIME-тип HTTP ответа: application/json
Created
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | UserProvidersResult | да | ||
| 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
/services/identityadminapi/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
/services/identityadminapi/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
/services/identityadminapi/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
/services/identityadminapi/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
/services/identityadminapi/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
/services/identityadminapi/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
/services/identityadminapi/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
/services/identityadminapi/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
/services/identityadminapi/api/Users/Claims/GetAll
Возвращает список Claims для указанной сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/api/Users/Claims/Create
Добавляет Claim для сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметр добавления Claim.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/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
/services/identityadminapi/api/Users/Claims/Update
Обновляет данные Claim для указанной сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры обновления Claim.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/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
/services/identityadminapi/api/Users/Providers/Delete
Удаляет у пользователя внешний провайдер.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметр удаления подключённого к пользователю внешнего провайдера.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| userId | string (uuid) | Уникальный идентификатор пользователя. | да | |
| providerName | string | Название внешнего провайдера аутентификации. | да | |
| providerUserId | string | Идентификатор пользователя во внешнем провайдере аутентификации. | да | |
| ldapDomainId | integer (int32) | Идентификатор домена LDAP. | нет |
Возвращаемые результаты
Код 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
/services/identityadminapi/api/Users/Providers/Create
Добавляет пользователю внешний провайдер.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметр добавления пользователю внешнего провайдера.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| userId | string (uuid) | Уникальный идентификатор пользователя. | да | |
| providerName | string | Название внешнего провайдера аутентификации. | да | |
| providerUserId | string | Идентификатор пользователя во внешнем провайдере аутентификации. | да | |
| ldapDomainId | integer (int32) | Идентификатор домена LDAP. | нет |
Возвращаемые результаты
Код 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