O Auth Tokens - List

Dienst:

Azure Data Manager for Agriculture

API-Version:

2023-11-01-preview

Gibt eine Liste von OAuthToken-Dokumenten zurück.

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

Mit optionalen Parametern:

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

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Der Hostname des Namespaces, z. B. admaInstanceName.farmbeats.azure.net
api-version	query	True	string	Die angeforderte API-Version
authProviderIds	query		string[]	Name von AuthProvider.
isValid	query		boolean	Wenn das Tokenobjekt gültig ist.
maxCreatedDateTime	query		string (date-time)	Maximale Erstellungsdatum der Ressource (einschließlich).
maxLastModifiedDateTime	query		string (date-time)	Maximales Datum der letzten Änderung der Ressource (einschließlich).
maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Maximale Anzahl der benötigten Elemente (einschließlich). Minimum = 10, Maximum = 1000, Standardwert = 50.
minCreatedDateTime	query		string (date-time)	Mindesterstellungsdatum der Ressource (einschließlich).
minLastModifiedDateTime	query		string (date-time)	Mindestdatum der letzten Änderung der Ressource (einschließlich).
partyIds	query		string[]	Liste der Parteien.
skipToken	query		string	Überspringen Sie das Token, um die nächste Gruppe von Ergebnissen zu erhalten.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Anrufe ausprobiert haben.

Antworten

Name	Typ	Beschreibung
200 OK	OAuthTokenListResponse	Erfolg
Other Status Codes	ErrorResponse	Fehler Header x-ms-error-code: string

Sicherheit

Authorization

Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Anrufe ausprobiert haben.

Typ: apiKey
In: header

Beispiele

OAuthTokens_List

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
Error	Fehler des Azure AgPlatform-Diensts.
ErrorResponse	Eine Fehlerantwort des Azure AgPlatform-Diensts. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses für ErrorResponse-Referenzdokument.
InnerError	Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.
OAuthToken	Schema der OAuth-Tokenressource.
OAuthTokenListResponse	Die seitenseitige Antwort enthält eine Liste der angeforderten Objekte und einen URL-Link, um den nächsten Satz von Ergebnissen abzurufen.

Error

Objekt

Fehler des Azure AgPlatform-Diensts.

Name	Typ	Beschreibung
code	string minLength: 1	Serverdefinierter Satz von Fehlercodes.
details	Error[]	Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerError	Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.
message	string minLength: 1	Lesbare Darstellung des Fehlers.
target	string	Ziel des Fehlers.

ErrorResponse

Objekt

Eine Fehlerantwort des Azure AgPlatform-Diensts. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses für ErrorResponse-Referenzdokument.

Name	Typ	Beschreibung
error	Error	Fehler des Azure AgPlatform-Diensts.
traceId	string	Eindeutige Ablaufverfolgungs-ID.

InnerError

Objekt

Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.

Name	Typ	Beschreibung
code	string	Spezifischer Fehlercode, der vom enthaltenden Fehler bereitgestellt wurde.
innererror	InnerError	Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.

OAuthToken

Objekt

Schema der OAuth-Tokenressource.

Name	Typ	Standardwert	Beschreibung
authProviderId	string minLength: 1		ID der OAuth-Anbieterressource, die App-Informationen enthält.
createdDateTime	string (date-time)		Datum-Uhrzeit der Erstellung der Ressource, Beispielformat: yyyy-MM-ddTHH:mm:ssZ.
eTag	string		Der ETag-Wert, der optimistische Parallelität implementiert.
isValid	boolean	True	Ein optionales Flag, das angibt, ob das Token ein gültiger oder abgelaufener Wert ist (Standardwert: true).
modifiedDateTime	string (date-time)		Datum-Uhrzeit der letzten Änderung der Ressource, Beispielformat: yyyy-MM-ddTHH:mm:ssZ.
partyId	string		Party-ID für diese OAuth-Konfiguration.

OAuthTokenListResponse

Objekt

Die seitenseitige Antwort enthält eine Liste der angeforderten Objekte und einen URL-Link, um den nächsten Satz von Ergebnissen abzurufen.

Name	Typ	Beschreibung
nextLink	string	Fortsetzungslink (absoluter URI) zur nächsten Seite der Ergebnisse in der Liste.
skipToken	string	Token, das beim Abrufen der nächsten Seite verwendet wird. Wenn null ist, gibt es keine zusätzlichen Seiten.
value	OAuthToken[]	Liste der angeforderten Objekte.