Сервис управления сущностями клиентов.
/services/identityadminapi/api/Clients/GetAllFull
Возвращает список всех доступных клиентов OpenIdConnect с полной информацией.
Тип HTTP запроса: post
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ClientFullResult[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/services/identityadminapi/api/Clients/GetAll
Возвращает список всех доступных сущностей OpenIdConnect.
Тип HTTP запроса: post
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ClientResult[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/services/identityadminapi/api/Clients/GetOneById
Возвращает информацию о сущности по идентификатору.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Уникальный идентификатор сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные зн ачения |
|---|---|---|---|---|
| result | ClientFullResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/services/identityadminapi/api/Clients/GetOneByName
Возвращает информацию о клиенте по имени.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Имя клиента.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Имя записи. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ClientFullResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/services/identityadminapi/api/Clients/Create
Добавляет новую сущность.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Данные нов ой сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| clientId | string | Название (Id) клиента. | да | |
| clientName | string | Имя клиента. | да | |
| description | string | Описание клиента. | нет | |
| nonEditable | boolean | Флаг неизменяемости. | нет | |
| enabled | boolean | Статус активности клиента. | нет | |
| clientUri | string | Зарезервированный адрес клиента. | нет | |
| protocolType | string | Тип протокола, по которому взаимодействует клиент. По умолчанию "oidc". | нет | |
| requireClientSecret | boolean | Флаг, указывающий, требуется ли ClientSecret для данного клиента. | нет | |
| allowedGrantTypes | ValueItem[] | Список доступных GrantTypes. | нет | |
| allowedScopes | ValueItem[] | Список доступных Scopes для клиента. | нет | |
| redirectUris | ValueItem[] | Список адресов, по которым можно произвести Redirect после входа в систему. | нет | |
| postLogoutRedirectUris | ValueItem[] | Список адресов, по которым можно произвести Redirect после выхода из системы. | нет | |
| properties | KeyValueItem[] | Список свойств клиента. | нет | |
| logoUri | string | Адрес для логотипа данного клиента. | нет | |
| requirePkce | boolean | Флаг, указывающий, должны ли клиенты, использующие тип предоставления на основе кода авторизации, отправлять ключ подтверждения. | нет | |
| identityTokenLifetime | integer (int32) | Время жизни identity токена. | нет | |
| accessTokenLifetime | integer (int32) | Время жизни access токена. | нет | |
| authorizationCodeLifetime | integer (int32) | Время жизни authorization code. | нет | |
| absoluteRefreshTokenLifetime | integer (int32) | Абсолютное время жизни refresh токена. | нет | |
| slidingRefreshTokenLifetime | integer (int32) | Время жизни refresh токена в секундах. По умолчанию 1296000 секунд (15 дней). | нет | |
| refreshTokenUsage | integer (int32) | Тип использования refresh токена: ReUse (0) - после обновления останется прежним при обновлении токенов; OneTime (1) - будет обновлён при обновлении токенов (это значение по умолчанию). | нет | |
| refreshTokenExpiration | integer (int32) | Тип срока жизни refresh токена: Absolute (1) - refresh токен истечёт в фиксированный момент времени (указанный в ASE.MD.Platform.Infrastructure.Identity.Admin.Shared.Interfaces.Models.IClientInfo.AbsoluteRefreshTokenLifetime); Sliding (0) - при обновлении token время жизни token обновления будет продлено (на сумму, указанную в ASE.MD.Platform.Infrastructure.Identity.Admin.Shared.Interfaces.Models.IClientInfo.SlidingRefreshTokenLifetime). Время жизни не будет превышать значения ASE.MD.Platform.Infrastructure.Identity.Admin.Shared.Interfaces.Models.IClientInfo.AbsoluteRefreshTokenLifetime. | нет | |
| updateAccessTokenClaimsOnRefresh | boolean | Флаг, указывающий, следует ли обновлять access токен (и его claims) при запросе refresh токена. | нет | |
| accessTokenType | integer (int32) | Указывает, является ли access токен ссылочным (значение 1) или автономным JWT (значение 0). По умолчанию JWT. | нет | |
| includeJwtId | boolean | Флаг, указывающий, должны ли токены доступа JWT иметь встроенный уникальный идентификатор (через Claim jti). По ум олчанию true. | нет | |
| allowedCorsOrigins | ValueItem[] | Список доступных CORS адресов. | нет | |
| alwaysSendClientClaims | boolean | Флаг, указывающий, нужно ли отправлять claims по каждому flow аутентификации. Если нет, то только по client credentials. | нет | |
| alwaysIncludeUserClaimsInIdToken | boolean | Флаг, указывающий, нужно ли при запросе identity и access токенов добавлять claims пользователя вместо того, чтобы требовать от клиента использовать UserInfo endpoint. | нет | |
| clientClaimsPrefix | string | Префикс для отображения клиентских claims. | нет | |
| pairWiseSubjectSalt | string | Значение соли, используемое при попарном генерировании SubjectId для пользователей этого клиента. | нет | |
| allowAccessTokensViaBrowser | boolean | Флаг, указывающий, разрешено ли этому клиенту получать access токен через браузер. | нет | |
| requireConsent | boolean | Флаг, указывающий, требуется ли открывать окно пользовательских соглашений. | нет | |
| allowRememberConsent | boolean | Флаг, дающий разрешение на сохранение согласий для пользователя. | нет | |
| consentLifetime | integer (int32) | Срок действия согласия пользователя в секундах. | нет | |
| allowOfflineAccess | boolean | Флаг, дающий возможность получения offline доступа (то есть возможность получения refresh токена). | нет | |
| allowPlainTextPkce | boolean | Указывает, могут ли клиенты, использующие PKCE, использовать вызов простого текстового кода (не рекомендуется и по умолчанию false). | нет | |
| frontChannelLogoutUri | string | Задаёт URI выхода на клиенте для выхода из внешнего канала на основе HTTP. Более подробную информацию можно найти в спецификации OIDC Front-Channel. | нет | |
| frontChannelLogoutSessionRequired | boolean | Указывает, следует ли отправлять идентификатор сеанса пользователя в FrontChannelLogoutUri. По умолчанию true. | нет | |
| backChannelLogoutUri | string | Задаёт URI выхода на клиенте для выхода из обратного канала на основе HTTP. Более подробную информацию можно найти спецификацию обратного канала OIDC. | нет | |
| backChannelLogoutSessionRequired | boolean | Указывает, следует ли отправлять идентификатор сеанса пользователя в запросе BackChannelLogoutUri. По умолчанию true. | нет | |
| userSsoLifetime | integer (int32) | Максимальная продолжительность (в секундах) с момента последней аутентификации пользователя. По умолчанию null. Вы можете настроить время жизни токена сеанса, чтобы контролировать, когда и как часто пользователю требуется повторно вводить учётные данные вместо автоматической аутентификации при использовании веб-приложения. | нет | |
| userCodeType | string | Тип кода пользователя, который будет использоваться для клиента. Если не задан, то будет использовано значение по умолчанию. | нет | |
| deviceCodeLifetime | integer (int32) | Срок службы кода устройства в секундах (по умолчанию 300 секунд). | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | IdResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/services/identityadminapi/api/Clients/Update
Обновляет данные о сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Данные обновляемой сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор сущности. | да | |
| clientId | string | Название (Id) клиента. | нет | |
| clientName | string | Имя клиента. | нет | |
| description | string | Описание клиента. | нет | |
| enabled | boolean | Статус активности клиента. | нет | |
| clientUri | string | Зарезервированный адрес клиента. | нет | |
| protocolType | string | Тип протокола, по которому взаимодействует клиент. По умолчанию "oidc". | нет | |
| requireClientSecret | boolean | Флаг, указывающий, требуется ли ClientSecret для данного клиента. | нет | |
| logoUri | string | Адрес для логотипа данного клиента. | нет | |
| requirePkce | boolean | Флаг, указывающий, должны ли клиенты, использующие тип предоставления на основе кода авторизации, отправлять ключ подтверждения. | нет | |
| identityTokenLifetime | integer (int32) | Время жизни identity токена. | нет | |
| accessTokenLifetime | integer (int32) | Время жизни access токена. | нет | |
| authorizationCodeLifetime | integer (int32) | Время жизни authorization code. | нет | |
| absoluteRefreshTokenLifetime | integer (int32) | Абсолютное время жизни refresh токена. | нет | |
| slidingRefreshTokenLifetime | integer (int32) | Время жизни refresh токена в секундах. По умолчанию 1296000 секунд (15 дней). | нет | |
| refreshTokenUsage | integer (int32) | Тип использования refresh токена: ReUse (0) - после обновления останется прежним при обновлении токенов; OneTime (1) - будет обновлён при обновлении токенов (это значение по умолчанию). | нет | |
| refreshTokenExpiration | integer (int32) | Тип срока жизни refresh токена: Absolute (1) - refresh токен истечёт в фиксированный момент времени (указанный в ASE.MD.Platform.Infrastructure.Identity.Admin.Shared.Interfaces.Models.IClientInfo.AbsoluteRefreshTokenLifetime); Sliding (0) - при обновлении token время жизни token обновления будет продлено (на сумму, указанную в ASE.MD.Platform.Infrastructure.Identity.Admin.Shared.Interfaces.Models.IClientInfo.SlidingRefreshTokenLifetime). Время жизни не будет превышать значения ASE.MD.Platform.Infrastructure.Identity.Admin.Shared.Interfaces.Models.IClientInfo.AbsoluteRefreshTokenLifetime. | нет | |
| updateAccessTokenClaimsOnRefresh | boolean | Флаг, указывающий, следует ли обновлять access токен (и его claims) при запросе refresh токена. | нет | |
| accessTokenType | integer (int32) | Указывает, является ли access токен ссылочным (значение 1) или автономным JWT (значение 0). По умолчанию JWT. | нет | |
| includeJwtId | boolean | Флаг, указывающий, должны ли токены доступа JWT иметь встроенный уникальный идентификатор (через Claim jti). По умолчанию true. | нет | |
| alwaysSendClientClaims | boolean | Флаг, указывающий, нужно ли отправлять claims по каждому flow аутентификации. Если нет, то только по client credentials. | нет | |
| alwaysIncludeUserClaimsInIdToken | boolean | Флаг, указывающий, нужно ли при запросе identity и access токенов добавлять claims пользователя вместо того, чтобы требовать от клиента использовать UserInfo endpoint. | нет | |
| clientClaimsPrefix | string | Префикс для отображения клиентских claims. | нет | |
| pairWiseSubjectSalt | string | Значение соли, используемое при попарном генерировании SubjectId для пользователей этого клиента. | нет | |
| allowAccessTokensViaBrowser | boolean | Флаг, указывающий, разрешено ли этому клиенту получать access токен через браузер. | нет | |
| requireConsent | boolean | Флаг, указывающий, требуется ли открывать окно пользовательских соглашений. | нет | |
| allowRememberConsent | boolean | Флаг, дающий разрешение на сохранение согласий для пользователя. | нет | |
| consentLifetime | integer (int32) | Срок действия согласия пользователя в секундах. | нет | |
| allowOfflineAccess | boolean | Флаг, дающий возможность получения offline доступа (то есть возможность получения refresh токена). | нет | |
| allowPlainTextPkce | boolean | Указывает, могут ли клиенты, использующие PKCE, использовать вызов простого текстового кода (не рекомендуется и по умолчанию false). | нет | |
| frontChannelLogoutUri | string | Задаёт URI выхода на клиенте для выхода из внешнего канала на основе HTTP. Более подробную информацию можно найти в спецификации OIDC Front-Channel. | нет | |
| frontChannelLogoutSessionRequired | boolean | Указывает, сл едует ли отправлять идентификатор сеанса пользователя в FrontChannelLogoutUri. По умолчанию true. | нет | |
| backChannelLogoutUri | string | Задаёт URI выхода на клиенте для выхода из обратного канала на основе HTTP. Более подробную информацию можно найти спецификацию обратного канала OIDC. | нет | |
| backChannelLogoutSessionRequired | boolean | Указывает, следует ли отправлять идентификатор сеанса пользователя в запросе BackChannelLogoutUri. По умолчанию true. | нет | |
| userSsoLifetime | integer (int32) | Максимальная продолжительность (в секундах) с момента последней аутентификации пользователя. По умолчанию null. Вы можете настроить время жизни токена сеанса, чтобы контролировать, когда и как часто пользователю требуется повторно вводить учётные данные вместо автоматической аутентификации при использовании веб-приложения. | нет | |
| userCodeType | string | Тип кода пользователя, который будет использоваться для клиента. Если не задан, то будет использовано значение по умолчанию. | нет | |
| deviceCodeLifetime | integer (int32) | Срок службы кода устройства в секундах (по умолчанию 300 секунд). | нет | |
| nonEditable | 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/Clients/UpdateFull
Обновляет данные о клиенте.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Данные обновляемого клиента.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| allowedCorsOrigins | ValueItem[] | Список доступных CORS адресов. При значении null обновление не применяется. | нет | |
| allowedGrantTypes | ValueItem[] | Список доступных GrantTypes. При значении null обновление не применяется. | нет | |
| allowedScopes | ValueItem[] | Список доступных Scopes для клиента. При значении null обновление не применяется. | нет | |
| redirectUris | ValueItem[] | Список адресов, по которым можно произвести Redirect после входа в систему. При значении null обновление не применяется. | нет | |
| postLogoutRedirectUris | ValueItem[] | Список адресов, по которым можно произвести Redirect после выхода из системы. При значении null обновление не применяется. | нет | |
| properties | KeyValueItem[] | Список свойств. | нет | |
| id | integer (int32) | Уникальный идентификатор сущности. | да | |
| clientId | string | Название (Id) клиента. | нет | |
| clientName | string | Имя клиента. | нет | |
| description | string | Описание клиента. | нет | |
| enabled | boolean | Статус активности клиента. | нет | |
| clientUri | string | Зарезервированный адрес клиента. | нет | |
| protocolType | string | Тип протокола, по которому взаимодействует клиент. По умолчанию "oidc". | нет | |
| requireClientSecret | boolean | Флаг, указывающий, требуется ли ClientSecret для данного клиента. | нет | |
| logoUri | string | Адрес для логотипа данного клиента. | нет | |
| requirePkce | boolean | Флаг, указывающий, должны ли клиенты, использующие тип предоставления на основе кода авторизации, отправлять ключ подтверждения. | нет | |
| identityTokenLifetime | integer (int32) | Время жизни identity токена. | нет | |
| accessTokenLifetime | integer (int32) | Время жизни access токена. | нет | |
| authorizationCodeLifetime | integer (int32) | Время жизни authorization code. | нет | |
| absoluteRefreshTokenLifetime | integer (int32) | Абсолютное время жизни refresh токена. | нет | |
| slidingRefreshTokenLifetime | integer (int32) | Время жизни refresh токена в секундах. По умолчанию 1296000 секунд (15 дней). | нет | |
| refreshTokenUsage | integer (int32) | Тип использования refresh токена: ReUse (0) - после обновления останется прежним при обновлении токенов; OneTime (1) - будет обновлён при обновлении токенов (это значение по умолчанию). | нет | |
| refreshTokenExpiration | integer (int32) | Тип срока жизни refresh токена: Absolute (1) - refresh токен истечёт в фиксированный момент времени (указанный в ASE.MD.Platform.Infrastructure.Identity.Admin.Shared.Interfaces.Models.IClientInfo.AbsoluteRefreshTokenLifetime); Sliding (0) - при обновлении token время жизни token обновления будет продлено (на сумму, указанную в ASE.MD.Platform.Infrastructure.Identity.Admin.Shared.Interfaces.Models.IClientInfo.SlidingRefreshTokenLifetime). Время жизни не будет превышать значения ASE.MD.Platform.Infrastructure.Identity.Admin.Shared.Interfaces.Models.IClientInfo.AbsoluteRefreshTokenLifetime. | нет | |
| updateAccessTokenClaimsOnRefresh | boolean | Флаг, указывающий, следует ли обновлять access токен (и его claims) при запросе refresh токена. | нет | |
| accessTokenType | integer (int32) | Указывает, является ли access токен ссылочным (значение 1) или автономным JWT (значение 0). По умолчанию JWT. | нет | |
| includeJwtId | boolean | Флаг, указывающий, должны ли токены доступа JWT иметь встроенный уникальный идентификатор (ч ерез Claim jti). По умолчанию true. | нет | |
| alwaysSendClientClaims | boolean | Флаг, указывающий, нужно ли отправлять claims по каждому flow аутентификации. Если нет, то только по client credentials. | нет | |
| alwaysIncludeUserClaimsInIdToken | boolean | Флаг, указывающий, нужно ли при запросе identity и access токенов добавлять claims пользователя вместо того, чтобы требовать от клиента использовать UserInfo endpoint. | нет | |
| clientClaimsPrefix | string | Префикс для отображения клиентских claims. | нет | |
| pairWiseSubjectSalt | string | Значение соли, используемое при попарном генерировании SubjectId для пользователей этого клиента. | нет | |
| allowAccessTokensViaBrowser | boolean | Флаг, указывающий, разрешено ли этому клиенту получать access токен через браузер. | нет | |
| requireConsent | boolean | Флаг, указывающий, требуется ли открывать окно пользовательских соглашений. | нет | |
| allowRememberConsent | boolean | Флаг, дающий разрешение на сохранение согласий для пользователя. | нет | |
| consentLifetime | integer (int32) | Срок действия согласия пользователя в секундах. | нет | |
| allowOfflineAccess | boolean | Флаг, дающий возможность получения offline доступа (то есть возможность получения refresh токена). | нет | |
| allowPlainTextPkce | boolean | Указывает, могут ли клиенты, использующие PKCE, использовать вызов простого текстового кода (не рекомендуется и по умолчанию false). | нет | |
| frontChannelLogoutUri | string | Задаёт URI выхода на клиенте для выхода из внешнего канала на основе HTTP. Более подробную информацию можно найти в спецификации OIDC Front-Channel. | нет | |
| frontChannelLogoutSessionRequired | boolean | Указывает, следует ли отправлять идентификатор сеанса пользователя в FrontChannelLogoutUri. По умолчанию true. | нет | |
| backChannelLogoutUri | string | Задаёт URI выхода на клиенте для выхода из обратного канала на основе HTTP. Более подробную информацию можно найти спецификацию обратного канала OIDC. | нет | |
| backChannelLogoutSessionRequired | boolean | Указывает, следует ли отправлять идентификатор сеанса пользователя в запросе BackChannelLogoutUri. По умолчанию true. | нет | |
| userSsoLifetime | integer (int32) | Максимальная продолжительность (в секундах) с момента последней аутентификации пользователя. По умолчанию null. Вы можете настроить время жизни токена сеанса, чтобы контролировать, когда и как часто пользователю требуется повторно вводить учётные данные вместо автоматической аутентификации при использовании веб-приложения. | нет | |
| userCodeType | string | Тип кода пользователя, который будет использоваться для клиента. Если не задан, то будет использовано значение по умолчанию. | нет | |
| deviceCodeLifetime | integer (int32) | Срок службы кода устройства в секундах (по умолчанию 300 секунд). | нет | |
| nonEditable | 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/Clients/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
/services/identityadminapi/api/Clients/Secrets/GetAll
Возвращает список секретных ключей указанной сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Уникальный идентификатор сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ClientSecretsResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/services/identityadminapi/api/Clients/Secrets/GetOne
Возвращает данные по указанному секретному ключу.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Уникальный идентификатор секретного ключа.
| Название поля | Ти п поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ClientSecretResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/services/identityadminapi/api/Clients/Secrets/Create
Добавляет секретный ключ указанной сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Данные добавляемого секретного ключа.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| clientId | integer (int32) | Уникальный идентификатор клиента. | да | |
| value | string | Значение секретного ключа. | нет | |
| description | string | Описание секретного ключа. | нет | |
| expiration | string (date-time) | Время жизни секретного ключа. | нет | |
| type | string | Тип секретного ключа. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | IdResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/services/identityadminapi/api/Clients/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
/services/identityadminapi/api/Clients/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
/services/identityadminapi/api/Clients/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
/services/identityadminapi/api/Clients/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
/services/identityadminapi/api/Clients/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
/services/identityadminapi/api/Clients/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
/services/identityadminapi/api/Clients/Claims/GetAll
Возвращает список Claims сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | TypeValuesResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/services/identityadminapi/api/Clients/Claims/GetOne
Возвращает Claim сущности по идентификатору.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор Claim сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | TypeValueResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/services/identityadminapi/api/Clients/Claims/Create
Добавляет Claim сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры добавления Claim сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| type | 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
/services/identityadminapi/api/Clients/Claims/Update
Обновляет Claim сущности.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры обновления Claim сущности.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Уникальный идентификатор сущности. | да | |
| type | 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
/services/identityadminapi/api/Clients/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
/services/identityadminapi/api/Clients/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
/services/identityadminapi/api/Clients/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
/services/identityadminapi/api/Clients/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
/services/identityadminapi/api/Clients/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
/services/identityadminapi/api/Clients/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
/services/identityadminapi/api/Clients/RedirectUris/GetAll
Возвращает список RedirectUris клиента.
Тип 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
/services/identityadminapi/api/Clients/RedirectUris/GetOne
Возвращает RedirectUri клиента по идентификатору.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентифик атор RedirectUri клиента.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/api/Clients/RedirectUris/Create
Добавляет RedirectUri клиенту.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры добавления RedirectUri клиенту.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/api/Clients/RedirectUris/Update
Обновляет RedirectUri клиента.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры обновления RedirectUri клиента.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/api/Clients/RedirectUris/Delete
Удаляет RedirectUri клиента.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор RedirectUri клиента.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/api/Clients/PostLogoutRedirectUris/GetAll
Возвращает список PostLogoutRedirectUri клиента.
Тип 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
/services/identityadminapi/api/Clients/PostLogoutRedirectUris/GetOne
Возвращает PostLogoutRedirectUri клиента по идентификатору.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор PostLogoutRedirectUri клиента.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/api/Clients/PostLogoutRedirectUris/Create
Добавляет PostLogoutRedirectUri клиенту.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры добавления PostLogoutRedirectUri клиенту.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/api/Clients/PostLogoutRedirectUris/Update
Обновляет PostLogoutRedirectUri клиента.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры обновления PostLogoutRedirectUri клиента.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/api/Clients/PostLogoutRedirectUris/Delete
Удаляет PostLogoutRedirectUri клиента.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор PostLogoutRedirectUri клиента.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/api/Clients/GrantTypes/GetAll
Возвращает список GrantTypes клиента.
Тип 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
/services/identityadminapi/api/Clients/GrantTypes/GetOne
Возвращает GrantType клиента по идентификатору.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор GrantType клиента.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/api/Clients/GrantTypes/Create
Добавляет GrantType клиенту.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры добавления GrantType клиенту.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/api/Clients/GrantTypes/Update
Обновляет GrantType клиента.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры обновления GrantType клиента.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/api/Clients/GrantTypes/Delete
Удаляет GrantType клиента.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор GrantType клиента.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/api/Clients/CorsOrigins/GetAll
Возвращает список CorsOrigin клиента.
Тип 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
/services/identityadminapi/api/Clients/CorsOrigins/GetOne
Возвращает CorsOrigin клиента по идентификатору.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор CorsOrigin клиента.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/api/Clients/CorsOrigins/Create
Добавляет CorsOrigin клиенту.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры добавления CorsOrigin клиенту.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/api/Clients/CorsOrigins/Update
Обновляет CorsOrigin клиента.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры обновления CorsOrigin клиента.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/api/Clients/CorsOrigins/Delete
Удаляет CorsOrigin клиента.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор CorsOrigin клиента.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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
/services/identityadminapi/api/Clients/Providers/Add
Добавляет внешний провайдер клиенту.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры добавления внешнего провайдера клиенту.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| clientName | string | Имя клиента. | нет | |
| authenticationScheme | 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/Clients/Providers/Delete
Удаляет внешний провайдер у клиента.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметры удален ия внешнего провайдера у клиента.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| clientName | string | Имя клиента. | нет | |
| authenticationScheme | 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/Clients/Providers/List
Возвращает список внешних провайдеров клиента.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор клиента.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| clientName | string | Имя клиента. | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ClientProvider[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/services/identityadminapi/api/Clients/Providers/All
Возвращает список всех внешних провайдеров.
Тип HTTP запроса: post
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ClientProvider[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden