O Auth Tokens - List

Usługa:

Azure Data Manager for Agriculture

Wersja interfejsu API:

2023-11-01-preview

Zwraca listę dokumentów OAuthToken.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string uri	Nazwa hosta przestrzeni nazw, np. admaInstanceName.farmbeats.azure.net
api-version	query	True	string	Żądana wersja interfejsu API
authProviderIds	query		string[]	Nazwa AuthProvider.
isValid	query		boolean	Jeśli obiekt tokenu jest prawidłowy.
maxCreatedDateTime	query		string date-time	Maksymalna data utworzenia zasobu (włącznie).
maxLastModifiedDateTime	query		string date-time	Maksymalna data ostatniej modyfikacji zasobu (włącznie).
maxPageSize	query		integer int32	Maksymalna liczba potrzebnych elementów (włącznie). Minimum = 10, Maksimum = 1000, Wartość domyślna = 50.
minCreatedDateTime	query		string date-time	Minimalna data utworzenia zasobu (włącznie).
minLastModifiedDateTime	query		string date-time	Minimalna data ostatniej modyfikacji zasobu (włącznie).
partyIds	query		string[]	Lista stron.
skipToken	query		string	Pomiń token w celu uzyskania następnego zestawu wyników.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Podaj prawidłowy token elementu nośnego dla autoryzowanych wywołań interfejsu API. Pamiętaj, że może być konieczne wyczyszczenie pamięci podręcznej przeglądarki, jeśli wcześniej podjęto próbę nieuwierzytelnionego wywołania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	OAuthTokenListResponse	Powodzenie
Other Status Codes	ErrorResponse	Błąd Nagłówki x-ms-error-code: string

Zabezpieczenia

Authorization

Podaj prawidłowy token elementu nośnego dla autoryzowanych wywołań interfejsu API. Pamiętaj, że może być konieczne wyczyszczenie pamięci podręcznej przeglądarki, jeśli wcześniej podjęto próbę nieuwierzytelnionego wywołania.

Typ: apiKey
W: header

Przykłady

OAuthTokens_List

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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"
}

Definicje

Nazwa	Opis
Error	Błąd usługi Azure AgPlatform.
ErrorResponse	Odpowiedź o błędzie z usługi Azure AgPlatform. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses dokument referencyjny ErrorResponse.
InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokument referencyjny InnerError.
OAuthToken	Schemat zasobu tokenu OAuth.
OAuthTokenListResponse	Odpowiedź stronicowana zawiera listę żądanych obiektów i link adresu URL, aby uzyskać następny zestaw wyników.

Error

Błąd usługi Azure AgPlatform.

Nazwa	Typ	Opis
code	string	Zestaw kodów błędów zdefiniowanych przez serwer.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokument referencyjny InnerError.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź o błędzie z usługi Azure AgPlatform. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses dokument referencyjny ErrorResponse.

Nazwa	Typ	Opis
error	Error	Błąd usługi Azure AgPlatform.
traceId	string	Unikatowy identyfikator śledzenia.

InnerError

Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokument referencyjny InnerError.

Nazwa	Typ	Opis
code	string	Określony kod błędu niż został dostarczony przez błąd zawierający.
innererror	InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokument referencyjny InnerError.

OAuthToken

Schemat zasobu tokenu OAuth.

Nazwa	Typ	Domyślna wartość	Opis
authProviderId	string		Identyfikator zasobu dostawcy OAuth zawierającego informacje o aplikacji.
createdDateTime	string		Data i godzina utworzenia zasobu, przykładowy format: rrrr-MM-ddTHH:mm:ssZ.
eTag	string		Wartość ETag do zaimplementowania optymistycznej współbieżności.
isValid	boolean	True	Opcjonalna flaga wskazująca, czy token jest prawidłowy, czy wygasł (wartość domyślna: true).
modifiedDateTime	string		Data i godzina ostatniej modyfikacji zasobu, format próbki: rrrr-MM-ddTHH:mm:ssZ.
partyId	string		Identyfikator jednostki dla tej konfiguracji protokołu OAuth.

OAuthTokenListResponse

Odpowiedź stronicowana zawiera listę żądanych obiektów i link adresu URL, aby uzyskać następny zestaw wyników.

Nazwa	Typ	Opis
nextLink	string	Link kontynuacji (bezwzględny identyfikator URI) do następnej strony wyników na liście.
skipToken	string	Token używany podczas pobierania następnej strony. Jeśli wartość null, nie ma żadnych dodatkowych stron.
value	OAuthToken[]	Lista żądanych obiektów.