O Auth Providers - Get

Служба:

Azure Data Manager for Agriculture

Версия API:

2023-11-01-preview

Получите указанный ресурс oauthProvider.

GET {endpoint}/oauth/providers/{oauthProviderId}?api-version=2023-11-01-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Имя узла пространства имен, например admaInstanceName.farmbeats.azure.net
oauthProviderId	path	True	string	Идентификатор ресурса oauthProvider.
api-version	query	True	string	Запрошенная версия API

Заголовок запроса

Имя	Обязательно	Тип	Описание
Authorization	True	string	Укажите действительный маркер носителя для авторизованных вызовов API. Обратите внимание, что может потребоваться очистить кэш браузера, если вы ранее попытались отменить проверку подлинности вызовов.

Ответы

Имя	Тип	Описание
200 OK	OAuthProvider	Успех
Other Status Codes	ErrorResponse	Ошибка Заголовки x-ms-error-code: string

Безопасность

Authorization

Укажите действительный маркер носителя для авторизованных вызовов API. Обратите внимание, что может потребоваться очистить кэш браузера, если вы ранее попытались отменить проверку подлинности вызовов.

Тип: apiKey
В: header

Примеры

OAuthProviders_Get

Образец запроса

HTTP

GET {endpoint}/oauth/providers/JOHNDEERE?api-version=2023-11-01-preview

Пример ответа

Код состояния:

200

{
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "id": "JOHNDEERE",
  "eTag": "f8fad5b-d9cb-469f-a165-70867728950e",
  "createdDateTime": "2021-04-22T18:27:37Z",
  "modifiedDateTime": "2021-04-22T18:27:37Z",
  "name": "JD Integration",
  "description": "Oauth Flow",
  "properties": {
    "Party": "123"
  }
}

Определения

Имя	Описание
Error	Ошибка из службы Azure AgPlatform.
ErrorResponse	Ответ об ошибке службы Azure AgPlatform. Справочный документ ErrorResponse см. в https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
InnerError	Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.
OAuthProvider	Схема ресурса поставщика OAuth.

Error

Object

Ошибка из службы Azure AgPlatform.

Имя	Тип	Описание
code	string minLength: 1	Определяемый сервером набор кодов ошибок.
details	Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	InnerError	Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.
message	string minLength: 1	Читаемое человеком представление ошибки.
target	string	Цель ошибки.

ErrorResponse

Object

Ответ об ошибке службы Azure AgPlatform. Справочный документ ErrorResponse см. в https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Имя	Тип	Описание
error	Error	Ошибка из службы Azure AgPlatform.
traceId	string	Уникальный идентификатор трассировки.

InnerError

Object

Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.

Имя	Тип	Описание
code	string	Определенный код ошибки, чем был предоставлен содержащей ошибкой.
innererror	InnerError	Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.

OAuthProvider

Object

Схема ресурса поставщика OAuth.

Имя	Тип	Default value	Описание
apiKey	string minLength: 2 maxLength: 200		Ключ API OAuth для данного поставщика. Примечание. В настоящее время применимо к поставщику климата. Не будет отправлен в ответ.
appId	string minLength: 2 maxLength: 200		Идентификатор приложения OAuth для данного поставщика OAuth.
appSecret	string minLength: 2 maxLength: 200		Секрет приложения OAuth для данного поставщика. Примечание. Не будет отправлено в ответ.
createdBy	string		Создан идентификатором пользователя или клиента.
createdDateTime	string (date-time)		Дата создания ресурса, пример формата: гггг-ММ-ддTHH:мм:ssZ.
description	string minLength: 0 maxLength: 500		Текстовое описание ресурса.
eTag	string		Значение ETag для реализации оптимистического параллелизма.
id	string		Уникальный идентификатор поставщика OAuth.
isProductionApp	boolean	False	Необязательный флаг для определения готовности приложения к использованию в рабочих сценариях на стороне поставщика или нет. (Значение по умолчанию: false) Примечание. В настоящее время применимо к JohnDeere.
modifiedBy	string		Изменен идентификатором пользователя или клиента.
modifiedDateTime	string (date-time)		Дата и время последнего изменения ресурса: формат yy-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100		Имя для идентификации ресурса.
properties			Коллекция пар значений ключей, принадлежащих ресурсу. Каждая пара не должна иметь ключ больше 50 символов и не должна иметь значение больше 150 символов. Примечание. Поддерживаются не более 25 пар значений ключей для ресурса и только строк, числовых и датовых значений (гггг-ММ-ддTHH:мм:ssZ).