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

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

/api/Backup/SaveResourcesAndClients

Возвращает ресурсы и клиенты со скоупами в формате json.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Список интересующих ресурсов и клиентов.

Название поляТип поляОписаниеОбязательноеВозможные значения
resourceNamesstring[]Список имён ресурсов.нет
clientNamesstring[]Список имён клиентов.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/identityadminapi public BackupController SaveResourcesAndClients(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.ServicesListApiParam)

Тип схемы безопасности: 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/Backup/download/config

Возвращает ресурсы и клиенты со скоупами в формате json.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Список интересующих ресурсов и клиентов.

Название поляТип поляОписаниеОбязательноеВозможные значения
resourceNamesstring[]Список имён ресурсов.нет
clientNamesstring[]Список имён клиентов.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/identityadminapi public BackupController SaveIpIndependentResourcesAndClients(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.ServicesListApiParam)

Тип схемы безопасности: 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/Backup/UploadResourcesAndClients

Загружает на сервер ресурсы и клиенты со скоупами.

Тип HTTP запроса: post

Параметры

НазваниеТипОписаниеПередаётся вОбязательное
clearConfigurationbooleanОчистить конфигурацию при обновлении.queryнет

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Информация о клиентах и ресурсах.

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/identityadminapi public BackupController UploadResourcesAndClients(System.String, System.Boolean)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

НазваниеЗначение
ТипauthorizationCode
Авторизация/identity/connect/authorize
Выдача токена/identity/connect/token
Обновление
Области разрешений доступаidentityadminapi:apiscope: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/Backup/upload/string/config

Загружает на сервер ресурсы и клиенты со скоупами.

Тип HTTP запроса: post

Параметры

НазваниеТипОписаниеПередаётся вОбязательное
clearConfigurationbooleanОчистить конфигурацию при обновлении.queryнет

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Информация о клиентах и ресурсах.

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/identityadminapi public BackupController UploadIpIndependentResourcesAndClients(System.Object, System.Boolean)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

НазваниеЗначение
ТипauthorizationCode
Авторизация/identity/connect/authorize
Выдача токена/identity/connect/token
Обновление
Области разрешений доступаidentityadminapi:apiscope: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/Backup/UploadResourcesAndClientsFromFile

Загружает на сервер ресурсы и клиенты со скоупами.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: multipart/form-data

Название поляТип поляОписаниеОбязательноеВозможные значения
Filestring (binary)Файл для загрузки.да
ClearConfigurationbooleanФлаг, указывающий на необходимость очистить конфигурацию при обновлении.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/identityadminapi public BackupController UploadResourcesAndClientsFromFile(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.FileParam)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

НазваниеЗначение
ТипauthorizationCode
Авторизация/identity/connect/authorize
Выдача токена/identity/connect/token
Обновление
Области разрешений доступаidentityadminapi:apiscope: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/Backup/upload/file/config

Загружает на сервер ресурсы и клиенты со скоупами.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: multipart/form-data

Название поляТип поляОписаниеОбязательноеВозможные значения
Filestring (binary)Файл для загрузки.да
ClearConfigurationbooleanФлаг, указывающий на необходимость очистить конфигурацию при обновлении.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/identityadminapi public BackupController UploadIpIndependentResourcesAndClientsFromFile(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.FileParam)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

НазваниеЗначение
ТипauthorizationCode
Авторизация/identity/connect/authorize
Выдача токена/identity/connect/token
Обновление
Области разрешений доступаidentityadminapi:apiscope: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