O Auth Tokens - List

Služba:

Azure Data Manager for Agriculture

Verze rozhraní API:

2023-11-01-preview

Vrátí seznam dokumentů OAuthToken.

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

S volitelnými parametry:

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 identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string uri	Název hostitele oboru názvů, například admaInstanceName.farmbeats.azure.net
api-version	query	True	string	Požadovaná verze rozhraní API
authProviderIds	query		string[]	Název AuthProvider.
isValid	query		boolean	Pokud je objekt tokenu platný.
maxCreatedDateTime	query		string date-time	Maximální datum vytvoření prostředku (včetně).
maxLastModifiedDateTime	query		string date-time	Maximální datum poslední změny prostředku (včetně)
maxPageSize	query		integer int32	Maximální počet potřebných položek (včetně) Minimum = 10, Maximum = 1000, Výchozí hodnota = 50.
minCreatedDateTime	query		string date-time	Minimální datum vytvoření prostředku (včetně).
minLastModifiedDateTime	query		string date-time	Minimální datum poslední změny prostředku (včetně).
partyIds	query		string[]	Seznam stran.
skipToken	query		string	Pokud chcete získat další sadu výsledků, přeskočte token.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string	Zadejte platný nosný token pro autorizovaná volání rozhraní API. Mějte na paměti, že pokud jste dříve zkoušeli neověřovaná volání, možná budete muset vymazat mezipaměť prohlížeče.

Odpovědi

Name	Typ	Description
200 OK	OAuthTokenListResponse	Success
Other Status Codes	ErrorResponse	Chybová Hlavičky x-ms-error-code: string

Zabezpečení

Authorization

Zadejte platný nosný token pro autorizovaná volání rozhraní API. Mějte na paměti, že pokud jste dříve zkoušeli neověřovaná volání, možná budete muset vymazat mezipaměť prohlížeče.

Typ: apiKey
V: header

Příklady

OAuthTokens_List

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
Error	Došlo k chybě ze služby Azure AgPlatform.
ErrorResponse	Chybová odpověď ze služby Azure AgPlatform. Projděte si https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses referenční dokument ErrorResponse.
InnerError	Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.
OAuthToken	Schéma prostředku tokenu OAuth
OAuthTokenListResponse	Stránkovaná odpověď obsahuje seznam požadovaných objektů a odkaz url pro získání další sady výsledků.

Error

Došlo k chybě ze služby Azure AgPlatform.

Name	Typ	Description
code	string	Sada kódů chyb definovaná serverem.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerError	Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.
message	string	Pro člověka čitelná reprezentace chyby.
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď ze služby Azure AgPlatform. Projděte si https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses referenční dokument ErrorResponse.

Name	Typ	Description
error	Error	Došlo k chybě ze služby Azure AgPlatform.
traceId	string	Jedinečné ID trasování

InnerError

Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.

Name	Typ	Description
code	string	Konkrétní kód chyby, než byl poskytnut chybou obsahující chybu.
innererror	InnerError	Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.

OAuthToken

Schéma prostředku tokenu OAuth

Name	Typ	Default value	Description
authProviderId	string		ID prostředku poskytovatele OAuth obsahujícího informace o aplikaci
createdDateTime	string		Datum a čas vytvoření prostředku, ukázkový formát: yyyy-MM-ddTHH:mm:ssZ.
eTag	string		Hodnota ETag pro implementaci optimistické souběžnosti.
isValid	boolean	True	Volitelný příznak označující, jestli je token platný nebo jestli vypršela (výchozí hodnota: true).
modifiedDateTime	string		Datum a čas poslední změny prostředku, ukázkový formát: rrrr-MM-ddTHH:mm:ssZ.
partyId	string		ID strany pro tuto konfiguraci OAuth.

OAuthTokenListResponse

Stránkovaná odpověď obsahuje seznam požadovaných objektů a odkaz url pro získání další sady výsledků.

Name	Typ	Description
nextLink	string	Odkaz na pokračování (absolutní identifikátor URI) na další stránku výsledků v seznamu.
skipToken	string	Token použitý k načtení další stránky. Pokud je null, neexistují žádné další stránky.
value	OAuthToken[]	Seznam požadovaných objektů