O Auth Tokens - Get O Auth Connection Link

Служба:

Azure Data Manager for Agriculture

Версия API:

2023-11-01-preview

Возвращает ссылку подключения, необходимую в потоке OAuth.

POST {endpoint}/oauth/tokens/:connect?api-version=2023-11-01-preview

Параметры URI

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

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

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

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

Имя	Обязательно	Тип	Описание
oAuthProviderId	True	string	Идентификатор OAuthProvider.
partyId	True	string	Идентификатор партии.
userRedirectLink	True	string	Ссылка для перенаправления пользователя в конце потока oauth.
userRedirectState		string	Состояние для обратного предоставления при перенаправлении пользователя в конце потока oauth.

Ответы

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

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

Authorization

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

Тип: apiKey
В: header

Примеры

OAuthTokens_GetOAuthConnectionLink

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

HTTP

POST {endpoint}/oauth/tokens/:connect?api-version=2023-11-01-preview

{
  "partyId": "PARTY123",
  "oAuthProviderId": "JOHNDEERE",
  "userRedirectLink": "https://docs.microsoft.com",
  "userRedirectState": "code"
}

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

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

200

"Connection string"

Определения

Имя	Описание
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.
OAuthConnectRequest	Получение параметров запроса конфигурации 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.

OAuthConnectRequest

Получение параметров запроса конфигурации OAuth.

Имя	Тип	Описание
oAuthProviderId	string	Идентификатор OAuthProvider.
partyId	string	Идентификатор партии.
userRedirectLink	string	Ссылка для перенаправления пользователя в конце потока oauth.
userRedirectState	string	Состояние для обратного предоставления при перенаправлении пользователя в конце потока oauth.