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

O Auth Tokens - List

服务:

Azure Data Manager for Agriculture

API 版本:

2023-11-01-preview

返回 OAuthToken 文档的列表。

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

具有可选参数:

GET {endpoint}/oauth/tokens?authProviderIds={authProviderIds}&partyIds={partyIds}&isValid={isValid}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&maxPageSize={maxPageSize}&skipToken={skipToken}&api-version=2023-11-01-preview

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string uri	命名空间的主机名，例如 admaInstanceName.farmbeats.azure.net
api-version	query	True	string	请求的 API 版本
authProviderIds	query		string[]	AuthProvider 的名称。
isValid	query		boolean	令牌对象是否有效。
maxCreatedDateTime	query		string date-time	资源的最大创建日期 (非独占) 。
maxLastModifiedDateTime	query		string date-time	资源的上次修改日期上限 (非独占) 。
maxPageSize	query		integer int32	(非独占) 所需的项目数上限。 最小值 = 10，最大值 = 1000，默认值 = 50。
minCreatedDateTime	query		string date-time	资源的最小创建日期 (非独占) 。
minLastModifiedDateTime	query		string date-time	资源的上次修改日期的最小 (（含) ）。
partyIds	query		string[]	参与方列表。
skipToken	query		string	跳过用于获取下一组结果的令牌。

请求头

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

响应

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

安全性

Authorization

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

类型: apiKey
在: header

示例

OAuthTokens_List

示例请求

HTTP

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

示例响应

状态代码:

200

{
  "value": [
    {
      "partyId": "PARTY123",
      "authProviderId": "JOHNDEERE",
      "isValid": true,
      "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "createdDateTime": "2021-04-22T18:49:25Z",
      "modifiedDateTime": "2021-04-22T18:49:25Z"
    }
  ],
  "skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d"
}

定义

名称	说明
Error	Azure AgPlatform 服务出错。
ErrorResponse	来自 Azure AgPlatform 服务的错误响应。 请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 参考文档。
InnerError	包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。
OAuthToken	OAuth 令牌资源的架构。
OAuthTokenListResponse	分页响应包含请求的对象列表和用于获取下一组结果的 URL 链接。

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 服务的错误响应。 请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 参考文档。

名称	类型	说明
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 。

OAuthToken

OAuth 令牌资源的架构。

名称	类型	默认值	说明
authProviderId	string		包含应用信息的 OAuth 提供程序资源的 ID。
createdDateTime	string		创建资源的日期时间，示例格式：yyyy-MM-ddTHH:mm:ssZ。
eTag	string		实现乐观并发的 ETag 值。
isValid	boolean	True	指示令牌是有效还是过期的可选标志 (默认值：true) 。
modifiedDateTime	string		上次修改资源的日期时间，示例格式：yyyy-MM-ddTHH:mm:ssZ。
partyId	string		此 OAuth 配置的参与方 ID。

OAuthTokenListResponse

分页响应包含请求的对象列表和用于获取下一组结果的 URL 链接。

名称	类型	说明
nextLink	string	列表中下一页结果的继续链接（绝对 URI）。
skipToken	string	用于检索下一页的令牌。 如果为 null，则没有其他页。
value	OAuthToken[]	请求的对象列表。