Сервис управления сущностями ролей.
/services/identityadminapi/api/Roles/GetAll
Возвращает информацию обо всех ролях.
Тип HTTP запроса: post
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | RoleInfoResult[] | Данные результата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public RolesController GetAll()
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:role: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 |
/services/identityadminapi/api/Roles/GetOne
Возвращает информацию об одной роли на основе ее System.Guid идентификатора.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметр с System.Guid идентификатором роли.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | RoleInfoResult | |||
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public RolesController 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:role: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 |
/services/identityadminapi/api/Roles/GetOneByName
Возвращает информацию о роли по имени.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Имя роли.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Имя записи. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | RoleInfoResult | |||
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public RolesController GetOneByName(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.EntryNameApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:role: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 |
/services/identityadminapi/api/Roles/Create
Создает новую роль.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Модель создания новой роли.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Название роли. | да | |
| description | string | Описание. | нет | |
| providerName | string | Имя провайдера аутентификации, с которым необходимо связать новую роль. Доступные значения: "[provider_name]" - создаётся связь с указанным провайдером; "" - связь не создаётся; null - значение берётся из опций RolesSynchronization. | нет | |
| ldapDomainId | integer (int32) | Идентификатор домена LDAP. | нет | |
| readOnly | boolean | Флаг, указывающий, что объект доступен только для чтения. | нет |
Возвращаемые результаты
Код HTTP ответа: 201
MIME-тип HTTP ответа: application/json
Created
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | RoleInfoResult | |||
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код 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 RolesController Create(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Roles.AddRoleApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:role: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 |
/services/identityadminapi/api/Roles/Update
Обновляет информацию о роли.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Модель обновления роли.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Уникальный идентификатор роли. | да | |
| name | string | Название роли. | нет | |
| description | string | Описание. | нет | |
| readOnly | boolean | Флаг, указывающий, что объект доступен только для чтения. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | RoleInfoResult | |||
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public RolesController Update(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Roles.UpdateRoleApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:role: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 |
/services/identityadminapi/api/Roles/Delete
Удаляет роль на основе ее System.Guid идентификатора.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметр с System.Guid идентификатором роли.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME- тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public RolesController 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:role: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 |
/services/identityadminapi/api/Roles/GroupDelete
Удаление списка ролей (до 10 штук за раз).
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Список идентификаторов ролей.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| idParams | GuidIdApiParam[] | Список идентификаторов. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public RolesController 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:role: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 |
/services/identityadminapi/api/Roles/GetUsers
Возвращает список пользователей, которые принадлежат к определенной роли.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметр с System.Guid идентификатором роли.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | RoleUsersResult | |||
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public RolesController GetUsers(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:role: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 |
/services/identityadminapi/api/Roles/GetUsersAmount
Возвращает количество пользователей для роли.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Уникальный идентификатор роли.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | RoleUsersAmountResult | |||
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public RolesController GetUsersAmount(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:role: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 |
/services/identityadminapi/api/Roles/GetRoleChildren
Возвращает все роли в виде дерева.
Тип HTTP запроса: post
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | RoleChildrenResult | |||
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public RolesController GetRoleChildren()
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:role: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 |
/services/identityadminapi/api/Roles/GetRoleParents
Возвращает список родительских ролей.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Уникальный идентификатор роли.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | RoleInfoResult[] | Данные результата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public RolesController GetRoleParents(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:role: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 |
/services/identityadminapi/api/Roles/AddChild
Добавляет подгруппу в группу.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификаторы родительской и дочерней групп.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| parentId | string (uuid) | Идентификатор родительской роли. | да | |
| childId | string (uuid) | Идентификатор дочерней роли. | да |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public RolesController AddChild(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Roles.ParentChildApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:role: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 |
/services/identityadminapi/api/Roles/RemoveChild
Удаляет подгруппу из группы.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификаторы родительской и дочерней групп.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| parentId | string (uuid) | Идентификатор родительской роли. | да | |
| childId | string (uuid) | Идентификатор дочерней роли. | да |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public RolesController RemoveChild(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Roles.ParentChildApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:role: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 |
/services/identityadminapi/api/Roles/SetUsers
Задаёт список пользователей в роли (удаляет отсутствующих в переданном списке, добавляет всех существующих).
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор группы и список идентификаторов пользователей.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| userIds | string(uuid)[] | Уникальный идентификатор пользователя. | да | |
| roleId | string (uuid) | Уникальный идентификатор роли. | да |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные резул ьтата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public RolesController SetUsers(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Users.MultipleUsersRoleApiParam)
Тип схемы безопасности: 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 |
/services/identityadminapi/api/Roles/GetOneRoleChildren
Возвращает список всех дочерних ролей.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор роли.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | RoleInfoResult[] | Данные результата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public RolesController GetOneRoleChildren(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:role: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 |
/services/identityadminapi/api/Roles/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 | RoleClaimResult | |||
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public RolesController 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:role: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 |
/services/identityadminapi/api/Roles/Claims/GetAll
Возвращает все утверждения (claims), связанные с ролью.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметр с System.Guid идентификатором роли.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | RoleClaimsResult | |||
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public RolesController 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:role: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 |
/services/identityadminapi/api/Roles/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. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public RolesController 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:role: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 |
/services/identityadminapi/api/Roles/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. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public RolesController 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:role: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 |