O Auth Tokens - List

Servizio:
Azure Data Manager for Agriculture
Versione API:
2023-11-01-preview

Restituisce un elenco di documenti OAuthToken.

GET {endpoint}/oauth/tokens?api-version=2023-11-01-preview
Con parametri facoltativi: 
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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
 path True

string (uri)

Nome host dello spazio dei nomi, ad esempio admaInstanceName.farmbeats.azure.net
api-version
 query True

string

Versione dell'API richiesta
authProviderIds
 query

string[]

Nome di AuthProvider.
isValid
 query

boolean

Se l'oggetto token è valido.
maxCreatedDateTime
 query

string (date-time)

Data massima di creazione della risorsa (inclusiva).
maxLastModifiedDateTime
 query

string (date-time)

Data massima dell'ultima modifica della risorsa (inclusi).
maxPageSize
 query

integer (int32)

minimum: 10
maximum: 1000

Numero massimo di elementi necessari (inclusi). Minimo = 10, Massimo = 1000, Valore predefinito = 50.
minCreatedDateTime
 query

string (date-time)

Data minima di creazione della risorsa (inclusiva).
minLastModifiedDateTime
 query

string (date-time)

Data minima dell'ultima modifica della risorsa (inclusiva).
partyIds
 query

string[]

Elenco di parti.
skipToken
 query

string

Ignorare il token per ottenere il set di risultati successivo.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
Authorization True

string

Specificare un token di connessione valido per le chiamate API autorizzate. Si noti che potrebbe essere necessario cancellare la cache del browser se si è tentato di eseguire chiamate non autenticate prima.

Risposte

Nome Tipo Descrizione
200 OK

OAuthTokenListResponse

Successo
Other Status Codes

ErrorResponse

Errore

Intestazioni

x-ms-error-code: string

Sicurezza

Authorization

Specificare un token di connessione valido per le chiamate API autorizzate. Si noti che potrebbe essere necessario cancellare la cache del browser se si è tentato di eseguire chiamate non autenticate prima.

Tipo: apiKey
In: header

Esempio

OAuthTokens_List

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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"
}

Definizioni

Nome Descrizione
Error

Errore del servizio Azure AgPlatform.
ErrorResponse

Risposta di errore dal servizio Azure AgPlatform. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses per il documento di riferimento ErrorResponse.
InnerError

Errore interno contenente l'elenco degli errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object per il documento di riferimento su InnerError.
OAuthToken

Schema della risorsa token OAuth.
OAuthTokenListResponse

La risposta a pagina contiene un elenco di oggetti richiesti e un collegamento URL per ottenere il set di risultati successivo.

Error

Object

Errore del servizio Azure AgPlatform.

Nome Tipo Descrizione
code

string

minLength: 1

Set definito dal server di codici di errore.
details

Error[]

Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror

InnerError

Errore interno contenente l'elenco degli errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object per il documento di riferimento su InnerError.
message

string

minLength: 1

Rappresentazione leggibile dell'errore.
target

string

Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore dal servizio Azure AgPlatform. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses per il documento di riferimento ErrorResponse.

Nome Tipo Descrizione
error

Error

Errore del servizio Azure AgPlatform.
traceId

string

ID traccia univoco.

InnerError

Object

Errore interno contenente l'elenco degli errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object per il documento di riferimento su InnerError.

Nome Tipo Descrizione
code

string

Codice di errore specifico di quello fornito dall'errore contenitore.
innererror

InnerError

Errore interno contenente l'elenco degli errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object per il documento di riferimento su InnerError.

OAuthToken

Object

Schema della risorsa token OAuth.

Nome Tipo Valore predefinito Descrizione
authProviderId

string

minLength: 1

ID della risorsa del provider OAuth contenente informazioni sull'app.
createdDateTime

string (date-time)

Data e ora di creazione della risorsa, formato di esempio: aaaa-MM-ggTHH:mm:ssZ.
eTag

string

Valore ETag per implementare la concorrenza ottimistica.
isValid

boolean

True

Flag facoltativo che indica se il token è valido o scaduto (valore predefinito: true).
modifiedDateTime

string (date-time)

Data e ora dell'ultima modifica della risorsa, formato di esempio: aaaa-MM-ggTHH:mm:ssZ.
partyId

string

ID entità per questa configurazione OAuth.

OAuthTokenListResponse

Object

La risposta a pagina contiene un elenco di oggetti richiesti e un collegamento URL per ottenere il set di risultati successivo.

Nome Tipo Descrizione
nextLink

string

Collegamento di continuazione (URI assoluto) alla pagina successiva dei risultati nell'elenco.
skipToken

string

Token usato per recuperare la pagina successiva. Se null, non sono presenti pagine aggiuntive.
value

OAuthToken[]

Elenco di oggetti richiesti.