O Auth Tokens - Get O Auth Connection Link

Servizio:

Azure Data Manager for Agriculture

Versione API:

2023-11-01-preview

Restituisce il collegamento Connection necessario nel flusso OAuth.

POST {endpoint}/oauth/tokens/:connect?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

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.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
oAuthProviderId	True	string	ID dell'oggetto OAuthProvider.
partyId	True	string	ID della parte.
userRedirectLink	True	string	Collegamento a cui reindirizzare l'utente alla fine del flusso oauth.
userRedirectState		string	Stato da restituire quando si reindirizza l'utente, alla fine del flusso oauth.

Risposte

Nome	Tipo	Descrizione
200 OK	string	Operazione completata
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_GetOAuthConnectionLink

Esempio di richiesta

HTTP

POST {endpoint}/oauth/tokens/:connect?api-version=2023-11-01-preview

{
  "partyId": "PARTY123",
  "oAuthProviderId": "JOHNDEERE",
  "userRedirectLink": "https://docs.microsoft.com",
  "userRedirectState": "code"
}

Risposta di esempio

Codice di stato:

200

"Connection string"

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 il documento di riferimento ErrorResponse.
InnerError	Errore interno contenente l'elenco di errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object il documento di riferimento per InnerError.
OAuthConnectRequest	Ottenere i parametri di query di configurazione OAuth.

Error

Errore del servizio Azure AgPlatform.

Nome	Tipo	Descrizione
code	string	Set definito dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato questo errore segnalato.
innererror	InnerError	Errore interno contenente l'elenco di errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object il documento di riferimento per InnerError.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorResponse

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

Nome	Tipo	Descrizione
error	Error	Errore del servizio Azure AgPlatform.
traceId	string	ID di traccia univoco.

InnerError

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

Nome	Tipo	Descrizione
code	string	Codice di errore specifico di quello fornito dall'errore che lo contiene.
innererror	InnerError	Errore interno contenente l'elenco di errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object il documento di riferimento per InnerError.

OAuthConnectRequest

Ottenere i parametri di query di configurazione OAuth.

Nome	Tipo	Descrizione
oAuthProviderId	string	ID dell'oggetto OAuthProvider.
partyId	string	ID della parte.
userRedirectLink	string	Collegamento a cui reindirizzare l'utente alla fine del flusso oauth.
userRedirectState	string	Stato da restituire quando si reindirizza l'utente, alla fine del flusso oauth.