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

Identity Admin API

Версия 12.1.64

API для управления объектами Identity и OAuth2.0

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

Тип запросаНазваниеОписание
post/services/identityadminapi/api/ApiResources/GetAllВозвращает список всех доступных сущностей OpenIdConnect.
post/services/identityadminapi/api/ApiResources/GetOneByIdВозвращает информацию о сущности по идентификатору.
post/services/identityadminapi/api/ApiResources/GetOneByNameВозвращает ApiResource по имени.
post/services/identityadminapi/api/ApiResources/CreateДобавляет новую сущность.
post/services/identityadminapi/api/ApiResources/UpdateОбновляет данные о сущности.
post/services/identityadminapi/api/ApiResources/DeleteУдаляет сущность.
post/services/identityadminapi/api/ApiResources/Secrets/GetAllВозвращает список секретных ключей указанной сущности.
post/services/identityadminapi/api/ApiResources/Secrets/GetOneВозвращает данные по указанному секретному ключу.
post/services/identityadminapi/api/ApiResources/Secrets/CreateДобавляет секретный ключ указанной сущности.
post/services/identityadminapi/api/ApiResources/Secrets/DeleteУдаляет секретный ключ.
post/services/identityadminapi/api/ApiResources/Claims/GetAllВозвращает список Claims сущности.
post/services/identityadminapi/api/ApiResources/Claims/GetOneВозвращает Claim сущности по идентификатору.
post/services/identityadminapi/api/ApiResources/Claims/CreateДобавляет Claim сущности.
post/services/identityadminapi/api/ApiResources/Claims/UpdateОбновляет Claim сущности.
post/services/identityadminapi/api/ApiResources/Claims/DeleteУдаляет Claim сущности.
post/services/identityadminapi/api/ApiResources/Properties/GetAllВозвращает список свойств сущности.
post/services/identityadminapi/api/ApiResources/Properties/GetOneВозвращает свойство сущности по идентификатору.
post/services/identityadminapi/api/ApiResources/Properties/CreateДобавляет свойство сущности.
post/services/identityadminapi/api/ApiResources/Properties/UpdateОбновляет свойство сущности.
post/services/identityadminapi/api/ApiResources/Properties/DeleteУдаляет свойство сущности.
post/services/identityadminapi/api/ApiResources/Scopes/GetAllВозвращает список Scopes указанной сущности.
post/services/identityadminapi/api/ApiResources/Scopes/GetOneВозвращает Scope сущности по идентификатору.
post/services/identityadminapi/api/ApiResources/Scopes/CreateДобавляет Scope сущности.
post/services/identityadminapi/api/ApiResources/Scopes/UpdateОбновляет Scope сущности.
post/services/identityadminapi/api/ApiResources/Scopes/DeleteУдаляет Scope сущности.

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

Тип запросаНазваниеОписание
post/services/identityadminapi/api/ApiScopes/GetAllВозвращает список всех доступных сущностей OpenIdConnect.
post/services/identityadminapi/api/ApiScopes/GetOneByIdВозвращает информацию о сущности по идентификатору.
post/services/identityadminapi/api/ApiScopes/GetLinkedClientsВозвращает Clients, связанных с указанным ApiScope.
post/services/identityadminapi/api/ApiScopes/GetLinkedApiResourcesВозвращает ApiResources, связанных с указанным ApiScope.
post/services/identityadminapi/api/ApiScopes/CreateДобавляет новую сущность.
post/services/identityadminapi/api/ApiScopes/UpdateОбновляет данные о сущности.
post/services/identityadminapi/api/ApiScopes/DeleteУдаляет сущность.
post/services/identityadminapi/api/ApiScopes/Claims/GetAllВозвращает список Claims сущности.
post/services/identityadminapi/api/ApiScopes/Claims/GetOneВозвращает Claim сущности по идентификатору.
post/services/identityadminapi/api/ApiScopes/Claims/CreateДобавляет Claim сущности.
post/services/identityadminapi/api/ApiScopes/Claims/UpdateОбновляет Claim сущности.
post/services/identityadminapi/api/ApiScopes/Claims/DeleteУдаляет Claim сущности.
post/services/identityadminapi/api/ApiScopes/Properties/GetAllВозвращает список свойств сущности.
post/services/identityadminapi/api/ApiScopes/Properties/GetOneВозвращает свойство сущности по идентификатору.
post/services/identityadminapi/api/ApiScopes/Properties/CreateДобавляет свойство сущности.
post/services/identityadminapi/api/ApiScopes/Properties/UpdateОбновляет свойство сущности.
post/services/identityadminapi/api/ApiScopes/Properties/DeleteУдаляет свойство сущности.

Сервис выгрузки/загрузки конфигураций клиентов и ресурсов.

Тип запросаНазваниеОписание
post/services/identityadminapi/api/Backup/SaveResourcesAndClientsВозвращает ресурсы и клиенты со скоупами в формате json.
post/services/identityadminapi/api/Backup/download/configВозвращает ресурсы и клиенты со скоупами в формате json.
post/services/identityadminapi/api/Backup/UploadResourcesAndClientsЗагружает на сервер ресурсы и клиенты со скоупами.
post/services/identityadminapi/api/Backup/upload/string/configЗагружает на сервер ресурсы и клиенты со скоупами.
post/services/identityadminapi/api/Backup/UploadResourcesAndClientsFromFileЗагружает на сервер ресурсы и клиенты со скоупами.
post/services/identityadminapi/api/Backup/upload/file/configЗагружает на сервер ресурсы и клиенты со скоупами.

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

Тип запросаНазваниеОписание
post/services/identityadminapi/api/Clients/GetAllFullВозвращает список всех доступных клиентов OpenIdConnect с полной информацией.
post/services/identityadminapi/api/Clients/GetAllВозвращает список всех доступных сущностей OpenIdConnect.
post/services/identityadminapi/api/Clients/GetOneByIdВозвращает информацию о сущности по идентификатору.
post/services/identityadminapi/api/Clients/GetOneByNameВозвращает информацию о клиенте по имени.
post/services/identityadminapi/api/Clients/CreateДобавляет новую сущность.
post/services/identityadminapi/api/Clients/UpdateОбновляет данные о сущности.
post/services/identityadminapi/api/Clients/UpdateFullОбновляет данные о клиенте.
post/services/identityadminapi/api/Clients/DeleteУдаляет сущность.
post/services/identityadminapi/api/Clients/Secrets/GetAllВозвращает список секретных ключей указанной сущности.
post/services/identityadminapi/api/Clients/Secrets/GetOneВозвращает данные по указанному секретному ключу.
post/services/identityadminapi/api/Clients/Secrets/CreateДобавляет секретный ключ указанной сущности.
post/services/identityadminapi/api/Clients/Secrets/DeleteУдаляет секретный ключ.
post/services/identityadminapi/api/Clients/Scopes/GetAllВозвращает список Scopes указанной сущности.
post/services/identityadminapi/api/Clients/Scopes/GetOneВозвращает Scope сущности по идентификатору.
post/services/identityadminapi/api/Clients/Scopes/CreateДобавляет Scope сущности.
post/services/identityadminapi/api/Clients/Scopes/UpdateОбновляет Scope сущности.
post/services/identityadminapi/api/Clients/Scopes/DeleteУдаляет Scope сущности.
post/services/identityadminapi/api/Clients/Claims/GetAllВозвращает список Claims сущности.
post/services/identityadminapi/api/Clients/Claims/GetOneВозвращает Claim сущности по идентификатору.
post/services/identityadminapi/api/Clients/Claims/CreateДобавляет Claim сущности.
post/services/identityadminapi/api/Clients/Claims/UpdateОбновляет Claim сущности.
post/services/identityadminapi/api/Clients/Claims/DeleteУдаляет Claim сущности.
post/services/identityadminapi/api/Clients/Properties/GetAllВозвращает список свойств сущности.
post/services/identityadminapi/api/Clients/Properties/GetOneВозвращает свойство сущности по идентификатору.
post/services/identityadminapi/api/Clients/Properties/CreateДобавляет свойство сущности.
post/services/identityadminapi/api/Clients/Properties/UpdateОбновляет свойство сущности.
post/services/identityadminapi/api/Clients/Properties/DeleteУдаляет свойство сущности.
post/services/identityadminapi/api/Clients/RedirectUris/GetAllВозвращает список RedirectUris клиента.
post/services/identityadminapi/api/Clients/RedirectUris/GetOneВозвращает RedirectUri клиента по идентификатору.
post/services/identityadminapi/api/Clients/RedirectUris/CreateДобавляет RedirectUri клиенту.
post/services/identityadminapi/api/Clients/RedirectUris/UpdateОбновляет RedirectUri клиента.
post/services/identityadminapi/api/Clients/RedirectUris/DeleteУдаляет RedirectUri клиента.
post/services/identityadminapi/api/Clients/PostLogoutRedirectUris/GetAllВозвращает список PostLogoutRedirectUri клиента.
post/services/identityadminapi/api/Clients/PostLogoutRedirectUris/GetOneВозвращает PostLogoutRedirectUri клиента по идентификатору.
post/services/identityadminapi/api/Clients/PostLogoutRedirectUris/CreateДобавляет PostLogoutRedirectUri клиенту.
post/services/identityadminapi/api/Clients/PostLogoutRedirectUris/UpdateОбновляет PostLogoutRedirectUri клиента.
post/services/identityadminapi/api/Clients/PostLogoutRedirectUris/DeleteУдаляет PostLogoutRedirectUri клиента.
post/services/identityadminapi/api/Clients/GrantTypes/GetAllВозвращает список GrantTypes клиента.
post/services/identityadminapi/api/Clients/GrantTypes/GetOneВозвращает GrantType клиента по идентификатору.
post/services/identityadminapi/api/Clients/GrantTypes/CreateДобавляет GrantType клиенту.
post/services/identityadminapi/api/Clients/GrantTypes/UpdateОбновляет GrantType клиента.
post/services/identityadminapi/api/Clients/GrantTypes/DeleteУдаляет GrantType клиента.
post/services/identityadminapi/api/Clients/CorsOrigins/GetAllВозвращает список CorsOrigin клиента.
post/services/identityadminapi/api/Clients/CorsOrigins/GetOneВозвращает CorsOrigin клиента по идентификатору.
post/services/identityadminapi/api/Clients/CorsOrigins/CreateДобавляет CorsOrigin клиенту.
post/services/identityadminapi/api/Clients/CorsOrigins/UpdateОбновляет CorsOrigin клиента.
post/services/identityadminapi/api/Clients/CorsOrigins/DeleteУдаляет CorsOrigin клиента.
post/services/identityadminapi/api/Clients/Providers/AddДобавляет внешний провайдер клиенту.
post/services/identityadminapi/api/Clients/Providers/DeleteУдаляет внешний провайдер у клиента.
post/services/identityadminapi/api/Clients/Providers/ListВозвращает список внешних провайдеров клиента.
post/services/identityadminapi/api/Clients/Providers/AllВозвращает список всех внешних провайдеров.

Сервис управления политикой паролей.

Тип запросаНазваниеОписание
post/services/identityadminapi/api/PasswordPolicy/SetPasswordPolicyСохраняет политику паролей.
post/services/identityadminapi/api/PasswordPolicy/GetPasswordPolicyВозвращает политику паролей.
post/services/identityadminapi/api/PasswordPolicy/SetRequireChangeOnFirstLoginСохраняет параметр политики "Требовать изменения пароля при первом входе".
post/services/identityadminapi/api/PasswordPolicy/SetRequireDigitСохраняет параметр политики "В пароле должна быть цифра".
post/services/identityadminapi/api/PasswordPolicy/SetRequireLowercaseСохраняет параметр политики "В пароле должна быть строчная буква".
post/services/identityadminapi/api/PasswordPolicy/SetRequireNonAlphanumericСохраняет параметр политики "В пароле должен быть специальный символ".
post/services/identityadminapi/api/PasswordPolicy/SetRequireUppercaseСохраняет параметр политики "В пароле должна быть прописная буква".
post/services/identityadminapi/api/PasswordPolicy/SetMinimalLengthСохраняет параметр политики "Минимальная длина пароля".
post/services/identityadminapi/api/PasswordPolicy/SetLockUserMinutesСохраняет параметр политики "Время блокировки пользователя после нескольких неверных попыток ввести пароль".
post/services/identityadminapi/api/PasswordPolicy/SetExpirationDaysСохраняет параметр политики "Срок действия пароля в днях".
post/services/identityadminapi/api/PasswordPolicy/SetMaxFailCountСохраняет параметр политики "Максимальное количество неудачных попыток авторизации".
post/services/identityadminapi/api/PasswordPolicy/SetUniquePasswordsCountСохраняет параметр политики "Количество неповторяющихся паролей".
post/services/identityadminapi/api/PasswordPolicy/SetRequireCheckReusePasswordСохраняет параметр политики "Проверять, что пароль ещё не был использован".
post/services/identityadminapi/api/PasswordPolicy/SetRequireMaxFailCountСохраняет параметр политики "Проверять количество неудачных логинов".
post/services/identityadminapi/api/PasswordPolicy/SetRequireForcibleExitСохраняет параметр политики "Принудительный выход после простоя".
post/services/identityadminapi/api/PasswordPolicy/SetForceExitAfterDownTimeMinutesСохраняет параметр политики "Время простоя, после которого происходит принудительный выход (минуты)".
post/services/identityadminapi/api/PasswordPolicy/GetForceExitAfterDownTimeMinutesВозвращает значение параметра политики "Время простоя, после которого происходит принудительный выход (минуты)".
post/services/identityadminapi/api/PasswordPolicy/GetRequireForcibleExitВозвращает значение параметра политики "Принудительный выход после простоя".
post/services/identityadminapi/api/PasswordPolicy/GetRequireMaxFailCountВозвращает значение параметра политики "Проверять количество неудачных логинов".
post/services/identityadminapi/api/PasswordPolicy/GetRequireChangeOnFirstLoginВозвращает значение параметра политики "Требовать изменения пароля при первом входе".
post/services/identityadminapi/api/PasswordPolicy/GetRequireCheckReusePasswordВозвращает значение параметра политики "Проверять, что пароль ещё не был использован".
post/services/identityadminapi/api/PasswordPolicy/GetRequireDigitВозвращает значение параметра политики "В пароле должна быть цифра".
post/services/identityadminapi/api/PasswordPolicy/GetRequireLowercaseВозвращает значение параметра политики "В пароле должна быть строчная буква".
post/services/identityadminapi/api/PasswordPolicy/GetRequireNonAlphanumericВозвращает значение параметра политики "В пароле должен быть специальный символ".
post/services/identityadminapi/api/PasswordPolicy/GetRequireUppercaseВозвращает значение параметра политики "В пароле должна быть прописная буква".
post/services/identityadminapi/api/PasswordPolicy/GetMinimalLengthВозвращает значение параметра политики "Минимальная длина пароля".
post/services/identityadminapi/api/PasswordPolicy/GetLockUserMinutesВозвращает значение параметра политики "Время блокировки пользователя после нескольких неверных попыток ввести пароль".
post/services/identityadminapi/api/PasswordPolicy/GetExpirationDaysВозвращает значение параметра политики "Срок действия пароля в днях".
post/services/identityadminapi/api/PasswordPolicy/GetMaxFailCountВозвращает значение параметра политики "Максимальное количество неудачных попыток авторизации".
post/services/identityadminapi/api/PasswordPolicy/GetUniquePasswordsCountВозвращает значение параметра политики "Количество неповторяющихся паролей".

Сервис управления сущностями провайдеров аутентификации.

Тип запросаНазваниеОписание
post/services/identityadminapi/api/Providers/GetAllВозвращает список всех провайдеров аутентификации.
post/services/identityadminapi/api/Providers/GetOneByIdПолучение провайдера аутентификации по идентификатору.
post/services/identityadminapi/api/Providers/GetOneByNameВозвращает провайдер аутентификации по имени.
post/services/identityadminapi/api/Providers/UpdateОбновляет данные провайдера аутентификации.
post/services/identityadminapi/api/Providers/SynchronizeВыполняет синхронизацию с внешними провайдерами аутентификации.

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

Тип запросаНазваниеОписание
post/services/identityadminapi/api/Roles/GetAllВозвращает список всех ролей.
post/services/identityadminapi/api/Roles/GetOneВозвращает информацию о роли по идентификатору.
post/services/identityadminapi/api/Roles/GetOneByNameВозвращает информацию о роли по имени.
post/services/identityadminapi/api/Roles/CreateДобавляет новую роль.
post/services/identityadminapi/api/Roles/UpdateОбновляет существующую роль.
post/services/identityadminapi/api/Roles/DeleteУдаляет существующую роль.
post/services/identityadminapi/api/Roles/GroupDeleteУдаление списка ролей (до 10 штук за раз).
post/services/identityadminapi/api/Roles/GetUsersВозвращает список пользователей роли.
post/services/identityadminapi/api/Roles/GetUsersAmountВозвращает количество пользователей для роли.
post/services/identityadminapi/api/Roles/GetRoleChildrenВозвращает все роли в виде дерева.
post/services/identityadminapi/api/Roles/GetRoleParentsВозвращает список родительских ролей.
post/services/identityadminapi/api/Roles/AddChildДобавляет подгруппу в группу.
post/services/identityadminapi/api/Roles/RemoveChildУдаляет подгруппу из группы.
post/services/identityadminapi/api/Roles/SetUsersДобавляет пользователей в группу.
post/services/identityadminapi/api/Roles/GetOneRoleChildrenВозвращает список всех дочерних ролей.
post/services/identityadminapi/api/Roles/Claims/CreateДобавляет Claim для сущности.
post/services/identityadminapi/api/Roles/Claims/GetAllВозвращает список Claims для указанной сущности.
post/services/identityadminapi/api/Roles/Claims/UpdateОбновляет данные Claim для указанной сущности.
post/services/identityadminapi/api/Roles/Claims/DeleteУдаляет Claim для указанной сущности.

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

Тип запросаНазваниеОписание
post/services/identityadminapi/api/Synchronization/ForceSecuritySyncЗапускает процесс полной синхронизации с Security.

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

Тип запросаНазваниеОписание
post/services/identityadminapi/api/Users/GetAllВозвращает список всех пользователей.
post/services/identityadminapi/api/Users/GetOneВозвращает информацию о пользователе по идентификатору.
post/services/identityadminapi/api/Users/GetOneByLoginВозвращает информацию о пользователе по логину (username).
post/services/identityadminapi/api/Users/FindПоиск пользователей по условиям.
post/services/identityadminapi/api/Users/CreateДобавляет нового пользователя.
post/services/identityadminapi/api/Users/DeleteУдаляет пользователя.
post/services/identityadminapi/api/Users/GroupDeleteУдаление указанного списка пользователей. Возможно удаление максимум 10 пользователей в одном запросе.
post/services/identityadminapi/api/Users/UpdateОбновляет данные о пользователе.
post/services/identityadminapi/api/Users/SetPasswordУстанавливает пароль для пользователя.
post/services/identityadminapi/api/Users/ChangePasswordМеняет пароль для пользователя.
post/services/identityadminapi/api/Users/IsUserChangedInitialPasswordВозвращает результат проверки, был ли изменён первоначальный пароль пользователя.
post/services/identityadminapi/api/Users/SynchronizeDataWithProviderСинхронизирует данные пользователя.
post/services/identityadminapi/api/Users/SynchronizePasswordWithProviderСинхронизирует пароль пользователя.
post/services/identityadminapi/api/Users/UserFailedToLoginСохраняет информацию о неудачной попытке пользователя войти в систему.
post/services/identityadminapi/api/Users/GetRolesВозвращает список ролей пользователя.
post/services/identityadminapi/api/Users/AddToRoleДобавляет пользователю роль.
post/services/identityadminapi/api/Users/DeleteFromRoleУдаляет роль у пользователя.
post/services/identityadminapi/api/Users/LockUserБлокирует пользователя.
post/services/identityadminapi/api/Users/UnlockUserСнимает блокировку с пользователя.
post/services/identityadminapi/api/Users/GroupLockБлокирует список пользователей.
post/services/identityadminapi/api/Users/GroupUnlockСнимает блокировку со списка пользователей.
post/services/identityadminapi/api/Users/Claims/GetAllВозвращает список Claims для указанной сущности.
post/services/identityadminapi/api/Users/Claims/CreateДобавляет Claim для сущности.
post/services/identityadminapi/api/Users/Claims/DeleteУдаляет Claim для указанной сущности.
post/services/identityadminapi/api/Users/Claims/UpdateОбновляет данные Claim для указанной сущности.
post/services/identityadminapi/api/Users/Providers/GetAllВозвращает список внешних провайдеров, подключённых к пользователю.
post/services/identityadminapi/api/Users/Providers/DeleteУдаляет у пользователя внешний провайдер.
post/services/identityadminapi/api/Users/Providers/CreateДобавляет пользователю внешний провайдер.