O Auth Providers - Create Or Update

Ссылка

Служба:: Azure Data Manager for Agriculture

Версия API:: 2023-11-01-preview

Создает или обновляет ресурс oauthProvider.

PATCH {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

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

Media Types: "application/merge-patch+json"

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

Текст запроса

Media Types: "application/merge-patch+json"

Имя	Тип	Описание
apiKey	string	Ключ API OAuth для заданного поставщика. Примечание. В настоящее время применимо к поставщику климата. Не будет отправлен в ответ.
appId	string	Приложение OAuth идентификатор для заданного поставщика OAuth.
appSecret	string	Приложение OAuth секрет для заданного поставщика. Примечание. Не будет отправлен в ответе.
description	string	Текстовое описание ресурса.
isProductionApp	boolean	Необязательный флаг, определяющий, готово ли приложение к использованию в рабочих сценариях на стороне поставщика. (Значение по умолчанию: false) Примечание. В настоящее время применимо для JohnDeere.
name	string	Имя для идентификации ресурса.
properties		Коллекция пар "ключ-значение", принадлежащих ресурсу. Каждая пара не должна содержать ключ, превышающий 50 символов, и значение не должно превышать 150 символов. Примечание. Для ресурса можно указать не более 25 пар ключевых значений. Поддерживаются только значения string, numeral и datetime (гггг-ММ-ддTHH:мм:ссZ).

Ответы

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

Имя

Тип

Описание

200 OK

OAuthProvider

Успех

201 Created

OAuthProvider

Создание

Other Status Codes

ErrorResponse

Ошибка

Заголовки

x-ms-error-code: string

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

Authorization

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

Тип: apiKey
В: header

Примеры

OAuthProviders_CreateOrUpdate

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

HTTP

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

{
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "name": "JOHNDEERE",
  "description": "some description",
  "properties": {
    "orgId": "ORG123"
  }
}

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

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

{
  "id": "JOHNDEERE",
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "name": "JOHNDEERE",
  "description": "some description",
  "properties": {
    "orgId": "ORG123"
  },
  "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "createdDateTime": "2021-04-23T11:31:10Z",
  "modifiedDateTime": "2021-04-23T11:31:10Z"
}

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

{
  "id": "JOHNDEERE",
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "name": "JOHNDEERE",
  "description": "some description",
  "properties": {
    "orgId": "ORG123"
  },
  "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "createdDateTime": "2021-04-23T11:31:10Z",
  "modifiedDateTime": "2021-04-23T11:31:10Z"
}

Определения

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

Error

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

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

ErrorResponse

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

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

InnerError

Внутренняя ошибка, содержащая список ошибок. См 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

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

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

Поделиться через

O Auth Providers - Create Or Update

Параметры URI

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

Текст запроса

Ответы

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

Authorization

Примеры

OAuthProviders_CreateOrUpdate

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

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

Определения

Error

ErrorResponse

InnerError

OAuthProvider

Дополнительные ресурсы