O Auth Tokens - Get O Auth Connection Link

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

Az OAuth-folyamatban szükséges kapcsolatkapcsolatot adja vissza.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string uri	A névtér állomásneve, például admaInstanceName.farmbeats.azure.net
api-version	query	True	string	A kért API-verzió

Kérelem fejléce

Name	Kötelező	Típus	Description
Authorization	True	string	Adjon meg érvényes tulajdonosi jogkivonatot az engedélyezett API-hívásokhoz. Vegye figyelembe, hogy előfordulhat, hogy törölnie kell a böngésző gyorsítótárát, ha korábban nem hitelesített hívásokat próbált meg.

Kérelem törzse

Name	Kötelező	Típus	Description
oAuthProviderId	True	string	Az OAuthProvider azonosítója.
partyId	True	string	A buli azonosítója.
userRedirectLink	True	string	Hivatkozás a felhasználó átirányításához az oauth-folyamat végén.
userRedirectState		string	Állapot, amely a felhasználó átirányításakor vissza lesz adva az oauth-folyamat végén.

Válaszok

Name	Típus	Description
200 OK	string	Success
Other Status Codes	ErrorResponse	Hiba Headers x-ms-error-code: string

Biztonság

Authorization

Adjon meg érvényes tulajdonosi jogkivonatot az engedélyezett API-hívásokhoz. Vegye figyelembe, hogy előfordulhat, hogy törölnie kell a böngésző gyorsítótárát, ha korábban nem hitelesített hívásokat próbált meg.

Type: apiKey
In: header

Példák

OAuthTokens_GetOAuthConnectionLink

Sample Request

HTTP

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

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

Sample Response

Status code:

200

"Connection string"

Definíciók

Name	Description
Error	Az Azure AgPlatform szolgáltatás hibája.
ErrorResponse	Hibaválasz az Azure AgPlatform szolgáltatástól. Lásd https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses : ErrorResponse referenciadokumentum.
InnerError	A hibák listáját tartalmazó belső hiba. Lásd: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError referenciadokumentum.
OAuthConnectRequest	OAuth-konfigurációs lekérdezési paraméterek lekérése.

Error

Az Azure AgPlatform szolgáltatás hibája.

Name	Típus	Description
code	string	Kiszolgáló által definiált hibakódok.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerError	A hibák listáját tartalmazó belső hiba. Lásd: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError referenciadokumentum.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

ErrorResponse

Hibaválasz az Azure AgPlatform szolgáltatástól. Lásd https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses : ErrorResponse referenciadokumentum.

Name	Típus	Description
error	Error	Az Azure AgPlatform szolgáltatás hibája.
traceId	string	Egyedi nyomkövetési azonosító.

InnerError

A hibák listáját tartalmazó belső hiba. Lásd: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError referenciadokumentum.

Name	Típus	Description
code	string	A hibát tartalmazó hiba által megadott hibakód.
innererror	InnerError	A hibák listáját tartalmazó belső hiba. Lásd: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError referenciadokumentum.

OAuthConnectRequest

OAuth-konfigurációs lekérdezési paraméterek lekérése.

Name	Típus	Description
oAuthProviderId	string	Az OAuthProvider azonosítója.
partyId	string	A buli azonosítója.
userRedirectLink	string	Hivatkozás a felhasználó átirányításához az oauth-folyamat végén.
userRedirectState	string	Állapot, amely a felhasználó átirányításakor vissza lesz adva az oauth-folyamat végén.