你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

O Auth Tokens - Get O Auth Connection Link

Service:

Azure Data Manager for Agriculture

API Version:

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 的 ID。
partyId	True	string	群的 ID。
userRedirectLink	True	string	用于将用户重定向到 oauth 流末尾的链接。
userRedirectState		string	在 oauth 流末尾重定向用户时要返回的状态。

响应

名称	类型	说明
200 OK	string	Success
Other Status Codes	ErrorResponse	错误 Headers x-ms-error-code: string

安全性

Authorization

请为授权的 API 调用提供有效的持有者令牌。 请注意，如果之前尝试过未经身份验证的调用，则可能需要清除浏览器缓存。

Type: apiKey
In: header

示例

OAuthTokens_GetOAuthConnectionLink

Sample Request

HTTP

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

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

Sample Response

Status code:

200

"Connection string"

定义

名称	说明
Error	Azure AgPlatform 服务出错。
ErrorResponse	来自 Azure AgPlatform 服务的错误响应。 有关 ErrorResponse 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。
InnerError	包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。
OAuthConnectRequest	获取 OAuth 配置查询参数。

Error

Azure AgPlatform 服务出错。

名称	类型	说明
code	string	服务器定义的错误代码集。
details	Error[]	有关导致此报告错误的特定错误的详细信息数组。
innererror	InnerError	包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。
message	string	错误的用户可读表示形式。
target	string	错误的目标。

ErrorResponse

来自 Azure AgPlatform 服务的错误响应。 有关 ErrorResponse 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。

名称	类型	说明
error	Error	Azure AgPlatform 服务出错。
traceId	string	唯一跟踪 ID。

InnerError

包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。

名称	类型	说明
code	string	包含错误提供的特定错误代码。
innererror	InnerError	包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。

OAuthConnectRequest

获取 OAuth 配置查询参数。

名称	类型	说明
oAuthProviderId	string	OAuthProvider 的 ID。
partyId	string	群的 ID。
userRedirectLink	string	用于将用户重定向到 oauth 流末尾的链接。
userRedirectState	string	在 oauth 流末尾重定向用户时要返回的状态。