O Auth Tokens - List

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

Returnerar en lista över OAuthToken-dokument.

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-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string uri	Namnområdets värdnamn, t.ex. admaInstanceName.farmbeats.azure.net
api-version	query	True	string	Den begärda API-versionen
authProviderIds	query		string[]	Namnet på AuthProvider.
isValid	query		boolean	Om tokenobjektet är giltigt.
maxCreatedDateTime	query		string date-time	Maximalt skapandedatum för resursen (inklusive).
maxLastModifiedDateTime	query		string date-time	Maximalt senast ändrat datum för resursen (inklusive).
maxPageSize	query		integer int32	Maximalt antal objekt som behövs (inklusive). Minimum = 10, Maximum = 1000, Standardvärde = 50.
minCreatedDateTime	query		string date-time	Minsta skapandedatum för resursen (inklusive).
minLastModifiedDateTime	query		string date-time	Minsta senast ändrade datum för resursen (inklusive).
partyIds	query		string[]	Lista över parter.
skipToken	query		string	Hoppa över token för att hämta nästa uppsättning resultat.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Svar

Name	Typ	Description
200 OK	OAuthTokenListResponse	Klart
Other Status Codes	ErrorResponse	Fel Headers x-ms-error-code: string

Säkerhet

Authorization

Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Type: apiKey
In: header

Exempel

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

Definitioner

Name	Description
Error	Ett fel från Azure AgPlatform-tjänsten.
ErrorResponse	Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokument.
InnerError	Inre fel som innehåller en lista över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.
OAuthToken	Schema för OAuth-tokenresurs.
OAuthTokenListResponse	Sidsvaret innehåller en lista över begärda objekt och en URL-länk för att hämta nästa uppsättning resultat.

Error

Ett fel från Azure AgPlatform-tjänsten.

Name	Typ	Description
code	string	Serverdefinierad uppsättning felkoder.
details	Error[]	Matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerError	Inre fel som innehåller en lista över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.
message	string	Mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorResponse

Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokument.

Name	Typ	Description
error	Error	Ett fel från Azure AgPlatform-tjänsten.
traceId	string	Unikt spårnings-ID.

InnerError

Inre fel som innehåller en lista över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.

Name	Typ	Description
code	string	Specifik felkod än vad som angavs av det innehållande felet.
innererror	InnerError	Inre fel som innehåller en lista över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.

OAuthToken

Schema för OAuth-tokenresurs.

Name	Typ	Standardvärde	Description
authProviderId	string		ID för OAuth-providerresursen som innehåller appinformation.
createdDateTime	string		Datum-tid när resursen skapades, exempelformat: ååå-MM-ddTHH:mm:ssZ.
eTag	string		ETag-värdet för att implementera optimistisk samtidighet.
isValid	boolean	True	En valfri flagga som anger om token är giltig eller har upphört att gälla (standardvärde: true).
modifiedDateTime	string		Datum-tid när resursen senast ändrades, exempelformat: ååååå-MM-ddTHH:mm:ssZ.
partyId	string		Part-ID för den här OAuth-konfigurationen.

OAuthTokenListResponse

Sidsvaret innehåller en lista över begärda objekt och en URL-länk för att hämta nästa uppsättning resultat.

Name	Typ	Description
nextLink	string	Fortsättningslänk (absolut URI) till nästa sida med resultat i listan.
skipToken	string	Token som används för att hämta nästa sida. Om värdet är null finns det inga ytterligare sidor.
value	OAuthToken[]	Lista över begärda objekt.