O Auth Tokens - Get O Auth Connection Link

Služba:

Azure Data Manager for Agriculture

Verze rozhraní API:

2023-11-01-preview

Vrátí připojení potřebné v toku OAuth.

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

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.

Text požadavku

Name	Vyžadováno	Typ	Description
oAuthProviderId	True	string	Id of the OAuthProvider.
partyId	True	string	ID strany.
userRedirectLink	True	string	Odkaz na přesměrování uživatele na konci toku oauth
userRedirectState		string	Stav, který se má poskytnout zpět při přesměrování uživatele, na konci toku oauth.

Odpovědi

Name	Typ	Description
200 OK	string	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_GetOAuthConnectionLink

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:

200

"Connection string"

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.
OAuthConnectRequest	Získejte parametry konfiguračního dotazu OAuth.

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.

OAuthConnectRequest

Získejte parametry konfiguračního dotazu OAuth.

Name	Typ	Description
oAuthProviderId	string	Id of the OAuthProvider.
partyId	string	ID strany.
userRedirectLink	string	Odkaz na přesměrování uživatele na konci toku oauth
userRedirectState	string	Stav, který se má poskytnout zpět při přesměrování uživatele, na konci toku oauth.