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

/services/identityadminapi/api/Providers/GetAll

Возвращает список всех провайдеров аутентификации.

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

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

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

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

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

Success

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	AuthenticationProvider[]	Данные результата метода API.	нет
typeInfo	TypeInfo
error	IErrorDescription
isError	boolean	Получает признак наличия ошибки	нет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/identityadminapi public ProvidersController GetAll()

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

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

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

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	identityadminapi:provider:read

/components/securitySchemes/identityadminapi

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

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

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

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	identityadminapi:user:changepassword, identityadminapi:user:read, identityadminapi:user:write

/services/identityadminapi/api/Providers/GetOneById

Получение провайдера аутентификации по идентификатору.

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

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

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

Идентификатор провайдера аутентификации.

Название поля	Тип поля	Описание	Обязательное	Возможные значения
id	integer (int32)	Уникальный идентификатор.	нет

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

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

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

Success

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	AuthenticationProvider
typeInfo	TypeInfo
error	IErrorDescription
isError	boolean	Получает признак наличия ошибки	нет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/identityadminapi public ProvidersController GetOneById(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.IntIdApiParam)

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

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

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

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	identityadminapi:provider:read

/components/securitySchemes/identityadminapi

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

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

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

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	identityadminapi:user:changepassword, identityadminapi:user:read, identityadminapi:user:write

/services/identityadminapi/api/Providers/GetOneByName

Возвращает провайдер аутентификации по имени.

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

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

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

Имя провайдера аутентификации.

Название поля	Тип поля	Описание	Обязательное	Возможные значения
name	string	Имя записи.	нет

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

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

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

Success

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	AuthenticationProvider
typeInfo	TypeInfo
error	IErrorDescription
isError	boolean	Получает признак наличия ошибки	нет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/identityadminapi public ProvidersController GetOneByName(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.EntryNameApiParam)

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

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

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

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	identityadminapi:provider:read

/components/securitySchemes/identityadminapi

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

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

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

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	identityadminapi:user:changepassword, identityadminapi:user:read, identityadminapi:user:write

/services/identityadminapi/api/Providers/Update

Обновляет данные провайдера аутентификации.

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

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

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

Данные провайдера аутентификации.

Название поля	Тип поля	Описание	Обязательное	Возможные значения
id	integer (int32)	Уникальный идентификатор сущности.	да
providerName	string	Имя провайдера.	нет
authenticationScheme	string	Схема аутентификации.	нет
displayName	string	Отображаемое имя.	нет
description	string	Описание.	нет
welcomeText	string	Текст приветствия на странице входа.	нет
accessType	string	Тип использования.	нет
enabled	boolean	Флаг, указывающий, что провайдер доступен для использования.	нет
icon	string	Иконка провайдера в формате Base64.	нет
iconType	string	Тип иконки провайдера.	нет

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

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

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

Success

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	string	Данные результата метода API.	нет
typeInfo	TypeInfo
error	IErrorDescription
isError	boolean	Получает признак наличия ошибки	нет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/identityadminapi public ProvidersController Update(ASE.MD.Platform.Services.Identity.Admin.API.Contracts.ApiParams.Providers.UpdateProviderApiParam)

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

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

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

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	identityadminapi:provider:write

/components/securitySchemes/identityadminapi

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

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

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

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	identityadminapi:user:changepassword, identityadminapi:user:read, identityadminapi:user:write

/services/identityadminapi/api/Providers/Synchronize

Выполняет синхронизацию с внешними провайдерами аутентификации.

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

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

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

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

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

Success

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	string	Данные результата метода API.	нет
typeInfo	TypeInfo
error	IErrorDescription
isError	boolean	Получает признак наличия ошибки	нет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/identityadminapi public ProvidersController Synchronize()

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

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

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

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	identityadminapi:role:write

/components/securitySchemes/identityadminapi

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

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

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

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	identityadminapi:user:changepassword, identityadminapi:user:read, identityadminapi:user:write