O Auth Tokens - List
Retourneert een lijst met OAuthToken-documenten.
GET {endpoint}/oauth/tokens?api-version=2023-11-01-preview
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-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
De hostnaam van de naamruimte, bijvoorbeeld admaInstanceName.farmbeats.azure.net |
api-version
|
query | True |
string |
De aangevraagde API-versie |
auth
|
query |
string[] |
Naam van AuthProvider. |
|
is
|
query |
boolean |
Als het tokenobject geldig is. |
|
max
|
query |
string date-time |
Maximale aanmaakdatum van resource (inclusief). |
|
max
|
query |
string date-time |
Maximale datum van laatste wijziging van resource (inclusief). |
|
max
|
query |
integer int32 |
Maximum aantal benodigde items (inclusief). Minimum = 10, Maximum = 1000, Standaardwaarde = 50. |
|
min
|
query |
string date-time |
Minimale aanmaakdatum van resource (inclusief). |
|
min
|
query |
string date-time |
Minimale datum van laatste wijziging van resource (inclusief). |
|
party
|
query |
string[] |
Lijst van partijen. |
|
skip
|
query |
string |
Token overslaan voor het ophalen van de volgende set resultaten. |
Aanvraagkoptekst
Name | Vereist | Type | Description |
---|---|---|---|
Authorization | True |
string |
Geef een geldig Bearer-token op voor geautoriseerde API-aanroepen. Houd er rekening mee dat u mogelijk uw browsercache moet wissen als u eerder niet-geverifieerde aanroepen hebt geprobeerd. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
Geslaagd |
|
Other Status Codes |
Fout Kopteksten x-ms-error-code: string |
Beveiliging
Authorization
Geef een geldig Bearer-token op voor geautoriseerde API-aanroepen. Houd er rekening mee dat u mogelijk uw browsercache moet wissen als u eerder niet-geverifieerde aanroepen hebt geprobeerd.
Type:
apiKey
In:
header
Voorbeelden
OAuthTokens_List
Voorbeeldaanvraag
GET {endpoint}/oauth/tokens?api-version=2023-11-01-preview
Voorbeeldrespons
{
"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"
}
Definities
Name | Description |
---|---|
Error |
Een fout van de Azure AgPlatform-service. |
Error |
Een foutreactie van de Azure AgPlatform-service. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses voor het referentiedocument ErrorResponse. |
Inner |
Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument. |
OAuth |
Schema van OAuth-tokenresource. |
OAuth |
Paginad-antwoord bevat een lijst met aangevraagde objecten en een URL-koppeling om de volgende set resultaten op te halen. |
Error
Een fout van de Azure AgPlatform-service.
Name | Type | Description |
---|---|---|
code |
string |
Door de server gedefinieerde set foutcodes. |
details |
Error[] |
Matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid. |
innererror |
Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument. |
|
message |
string |
Door mensen leesbare weergave van de fout. |
target |
string |
Doel van de fout. |
ErrorResponse
Een foutreactie van de Azure AgPlatform-service. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses voor het referentiedocument ErrorResponse.
Name | Type | Description |
---|---|---|
error |
Een fout van de Azure AgPlatform-service. |
|
traceId |
string |
Unieke tracerings-id. |
InnerError
Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument.
Name | Type | Description |
---|---|---|
code |
string |
Specifieke foutcode dan is opgegeven door de betreffende fout. |
innererror |
Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument. |
OAuthToken
Schema van OAuth-tokenresource.
Name | Type | Default value | Description |
---|---|---|---|
authProviderId |
string |
Id van de resource van de OAuth-provider die app-gegevens bevat. |
|
createdDateTime |
string |
Datum-tijd waarop de resource is gemaakt, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ. |
|
eTag |
string |
De ETag-waarde voor het implementeren van optimistische gelijktijdigheid. |
|
isValid |
boolean |
True |
Een optionele vlag die aangeeft of het token geldig of verlopen is (standaardwaarde: true). |
modifiedDateTime |
string |
Datum/tijd waarop de resource voor het laatst is gewijzigd, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ. |
|
partyId |
string |
Partij-id voor deze OAuth-configuratie. |
OAuthTokenListResponse
Paginad-antwoord bevat een lijst met aangevraagde objecten en een URL-koppeling om de volgende set resultaten op te halen.
Name | Type | Description |
---|---|---|
nextLink |
string |
Vervolgkoppeling (absolute URI) naar de volgende pagina met resultaten in de lijst. |
skipToken |
string |
Token dat wordt gebruikt bij het ophalen van de volgende pagina. Indien null, zijn er geen extra pagina's. |
value |
Lijst met aangevraagde objecten. |