Сервис управления сущностями ApiResource.
/api/ApiResources/GetIdentityResources
Возвращает коллекцию IdentityResources с применением фильтров.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Фильтры для выборки IdentityResources.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| scopeNames | string[] | Список имён scope, по которым возвращать информацию. Если не задан, то возвращается по всем. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | IdentityResourceResult[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController GetIdentityResources(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.ApiResources.GetIdentityResourcesApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/GetFilteredList
Возвращает коллекцию ApiResources с применением фильтров.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Фильтры для выборки ApiResources.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| apiResourceNames | string[] | Фильтр по имени ApiResource. | нет | |
| scopeNames | string[] | Фильтр по скоупу ApiResource. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ApiResourceResult[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController GetFilteredList(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.ApiResources.GetFilteredApiResourcesApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/GetAll
Возвращает список всех доступных сущностей OpenIdConnect.
Тип HTTP запроса: post
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ApiResourceResult[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController GetAll()
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/GetOneById
Возвращает информацию о сущности по идентификатору.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Уникальный идентификатор сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ApiResourceResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController GetOneById(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.IntIdApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/GetOneByName
Возвращает ApiResource по имени.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Имя ApiResource.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Имя записи. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ApiResourceResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController 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:apiresource: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/ApiResources/Create
Добавляет новую сущность.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Данные новой сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Имя ApiResource. | да | |
| displayName | string | Отображаемое имя ApiResource. | да | |
| description | string | Описание ApiResource. | нет | |
| allowedAccessTokenSigningAlgorithms | string | Доступный алгоритм подписи токенов. | нет | |
| showInDiscoveryDocument | boolean | Флаг, определяющий, показывать ли информацию о ресурсе в DiscoveryDocument Identity. | нет | |
| enabled | boolean | Состояние активности ApiResource. | нет | |
| nonEditable | boolean | Флаг неизменяемости ресурса. | нет | |
| scopes | ValueItem[] | Список областей видимости, привязанных к ресурсу. | нет |
Возвращаемые результаты
Код HTTP ответа: 201
MIME-тип HTTP ответа: application/json
Created
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | IdResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 400
MIME-тип HTTP ответа: application/json
Bad Request
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| type | string | нет | ||
| title | string | нет | ||
| status | integer (int32) | нет | ||
| detail | string | нет | ||
| instance | string | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController Create(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.ApiResources.AddApiResourceApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/Update
Обновляет данные о сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Данные обновляемой сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор сущности. | да | |
| name | string | Имя ApiResource. | да | |
| displayName | string | Отображаемое имя ApiResource. | да | |
| description | string | Описание ApiResource. | нет | |
| allowedAccessTokenSigningAlgorithms | string | Доступный алгоритм подписи токенов. | нет | |
| showInDiscoveryDocument | boolean | Флаг, определяющий, показывать ли информацию о ресурсе в DiscoveryDocument Identity. | нет | |
| enabled | boolean | Состояние активности ApiResource. | нет | |
| nonEditable | boolean | Флаг неизменяемости ресурса. | нет | |
| scopes | ValueItem[] | Список областей видимости, привязанных к ресурсу. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController Update(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.ApiResources.UpdateApiResourceApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/Delete
Удаляет сущность.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Уникальный идентификатор сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор. | нет |
Возвр ащаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController Delete(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.IntIdApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновлен ие | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/Secrets/GetAll
Возвращает список секретных ключей указанной сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Уникальный идентификатор сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ApiResourceSecretsResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController GetAllSecrets(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.IntIdApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource:readsecret |
/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/ApiResources/Secrets/GetOne
Возвращает данные по указанному секретному ключу.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Уникальный идентификатор секретного ключа.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ApiResourceSecretResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController GetOneSecret(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.IntIdApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource:readsecret |
/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/ApiResources/Secrets/Create
Добавляет секретный ключ указанной сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Данные добавляемого секретного ключа.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| apiResourceId | integer (int32) | Уникальный идентификатор ApiResource. | да | |
| value | string | Значение секретного ключа. | нет | |
| description | string | Описание секретного ключа. | нет | |
| expiration | string (date-time) | Время жизни секретного ключа. | нет | |
| type | string | Тип секретного ключа. | нет |
Возвращаемые результаты
Код HTTP ответа: 201
MIME-тип HTTP ответа: application/json
Created
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | IdResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 400
MIME-тип HTTP ответа: application/json
Bad Request
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| type | string | нет | ||
| title | string | нет | ||
| status | integer (int32) | нет | ||
| detail | string | нет | ||
| instance | string | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController CreateSecret(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.ApiResources.AddApiResourceSecretApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource:writesecret |
/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/ApiResources/Secrets/Delete
Удаляет секретный ключ.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Уникальный идентификатор секретного ключа.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController DeleteSecret(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.IntIdApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource:writesecret |
/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/ApiResources/Claims/GetAll
Возвращает список Claims сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | TypesResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController GetAllClaims(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.IntIdApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/Claims/GetOne
Возвращает Claim сущности по идентификатору.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор Claim сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | TypeResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController GetOneClaim(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.IntIdApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/Claims/Create
Добавляет Claim сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры добавления Claim сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| entryOwnerId | integer (int32) | Уникальный идентификатор сущности, к которой относится значение. | да | |
| type | string | Тип сущности. | да |
Возвращаемые результаты
Код HTTP ответа: 201
MIME-тип HTTP ответа: application/json
Created
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | IdResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 400
MIME-тип HTTP ответа: application/json
Bad Request
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| type | string | нет | ||
| title | string | нет | ||
| status | integer (int32) | нет | ||
| detail | string | нет | ||
| instance | string | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController CreateClaim(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Common.AddTypeApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/Claims/Update
Обновляет Claim сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры обновления Claim сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор сущности. | да | |
| entryOwnerId | integer (int32) | Уникальный идентификатор сущности, к которой относится значение. | да | |
| type | string | Тип сущности. | да |
Возвращаемые результаты
Код HTTP ответа: 201
MIME-тип HTTP ответа: application/json
Created
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 400
MIME-тип HTTP ответа: application/json
Bad Request
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| type | string | нет | ||
| title | string | нет | ||
| status | integer (int32) | нет | ||
| detail | string | нет | ||
| instance | string | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController UpdateClaim(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Common.UpdateTypeApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/Claims/Delete
Удаляет Claim сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор Claim сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController DeleteClaim(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.IntIdApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/Properties/GetAll
Возвращает список свойств сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | KeyValuesResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController GetAllProperties(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.IntIdApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/Properties/GetOne
Возвращает свойство сущности по идентификатору.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор свойства сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | KeyValueResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController GetOneProperty(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.IntIdApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/Properties/Create
Добавляет свойство сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры добавления свойства сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| key | string | Ключ сущности. | да | |
| entryOwnerId | integer (int32) | Уникальный идентификатор сущности, к которой относится значение. | да | |
| value | string | Значение сущности. | да |
Возвращаемые результаты
Код HTTP ответа: 201
MIME-тип HTTP ответа: application/json
Created
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | IdResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 400
MIME-тип HTTP ответа: application/json
Bad Request
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| type | string | нет | ||
| title | string | нет | ||
| status | integer (int32) | нет | ||
| detail | string | нет | ||
| instance | string | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController CreateProperty(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Common.AddKeyValueApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/Properties/Update
Обновляет свойство сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры обновления свойства сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор сущности. | да | |
| key | string | Ключ сущности. | да | |
| entryOwnerId | integer (int32) | Уникальный идентификатор сущности, к которой относится значение. | да | |
| value | string | Значение сущности. | да |
Возвращаемые результаты
Код HTTP ответа: 201
MIME-тип HTTP ответа: application/json
Created
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 400
MIME-тип HTTP ответа: application/json
Bad Request
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| type | string | нет | ||
| title | string | нет | ||
| status | integer (int32) | нет | ||
| detail | string | нет | ||
| instance | string | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController UpdateProperty(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Common.UpdateKeyValueApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/Properties/Delete
Удаляет свойство сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор свойства сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController DeleteProperty(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.IntIdApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/Scopes/GetAll
Возвращает список Scopes указанной сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ValuesResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController GetAllScopes(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.IntIdApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/Scopes/GetOne
Возвращает Scope сущности по идентификатору.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор Scope сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ValueResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController GetOneScope(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.IntIdApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Зна чение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/Scopes/Create
Добавляет Scope сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Данные нового Scope.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| entryOwnerId | integer (int32) | Уникальный идентификатор сущности, к которой относится значение. | да | |
| value | string | Значение сущности. | да |
Возвращаемые результаты
Код HTTP ответа: 201
MIME-тип HTTP ответа: application/json
Created
| Название поля | Тип поля | Описание | Обязательное | Воз можные значения |
|---|---|---|---|---|
| result | IdResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 400
MIME-тип HTTP ответа: application/json
Bad Request
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| type | string | нет | ||
| title | string | нет | ||
| status | integer (int32) | нет | ||
| detail | string | нет | ||
| instance | string | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController CreateScope(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Common.AddValueApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/Scopes/Update
Обновляет Scope сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Данные обновляемого Scope.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор сущности. | да | |
| entryOwnerId | integer (int32) | Уникальный идентификатор сущности, к которой относится значение. | да | |
| value | string | Значение сущности. | да |
Возвращаемые результаты
Код HTTP ответа: 201
MIME-тип HTTP ответа: application/json
Created
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 400
MIME-тип HTTP ответа: application/json
Bad Request
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| type | string | нет | ||
| title | string | нет | ||
| status | integer (int32) | нет | ||
| detail | string | нет | ||
| instance | string | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController UpdateScope(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Common.UpdateValueApiParam)
Тип схемы безопасности: oauth2
Располо жение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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/ApiResources/Scopes/Delete
Удаляет Scope сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор Scope сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/identityadminapi public ApiResourcesController DeleteScope(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.IntIdApiParam)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | identityadminapi:apiresource: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 |