O Auth Tokens - List

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

Возвращает список документов OAuthToken.

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

With optional parameters:

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	Успех
Other Status Codes	ErrorResponse	Ошибка Headers x-ms-error-code: string

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

Authorization

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

Type: apiKey
In: header

Примеры

OAuthTokens_List

Sample Request

HTTP

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

Sample Response

Status code:

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	Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.
OAuthToken	Схема ресурса токена OAuth.
OAuthTokenListResponse	Выстраиваемый ответ содержит список запрошенных объектов и URL-ссылку для получения следующего набора результатов.

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.

OAuthToken

Схема ресурса токена OAuth.

Имя	Тип	Значение по умолчанию	Описание
authProviderId	string		Идентификатор ресурса поставщика OAuth, содержащего сведения о приложении.
createdDateTime	string		Дата и время создания ресурса. Пример формата: yyyy-MM-ddTHH:mm:ssZ.
eTag	string		Значение ETag для реализации оптимистичного параллелизма.
isValid	boolean	True	Необязательный флаг, указывающий, является ли маркер допустимым или просроченным (значение по умолчанию: true).
modifiedDateTime	string		Дата и время последнего изменения ресурса. Пример формата: yyyy-MM-ddTHH:mm:ssZ.
partyId	string		Идентификатор стороны для этой конфигурации OAuth.

OAuthTokenListResponse

Выстраиваемый ответ содержит список запрошенных объектов и URL-ссылку для получения следующего набора результатов.

Имя	Тип	Описание
nextLink	string	Ссылка продолжения (абсолютный URI), указывающая на следующую страницу списка результатов.
skipToken	string	Маркер, используемый при получении следующей страницы. Если значение равно null, дополнительные страницы отсутствуют.
value	OAuthToken[]	Список запрошенных объектов.