O Auth Tokens - Get O Auth Connection Link

Tjänst:

Azure Data Manager for Agriculture

API-version:

2023-11-01-preview

Returnerar anslutningslänken som behövs i OAuth-flödet.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (uri)	Namnområdets värdnamn, t.ex. admaInstanceName.farmbeats.azure.net
api-version	query	True	string	Den begärda API-versionen

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Begärandetext

Name	Obligatorisk	Typ	Description
oAuthProviderId	True	string minLength: 1	ID för OAuthProvider.
partyId	True	string minLength: 1	Id för festen.
userRedirectLink	True	string minLength: 0 maxLength: 1000	Länk för att omdirigera användaren till i slutet av oauth-flödet.
userRedirectState		string minLength: 0 maxLength: 200	Tillstånd att ange när användaren omdirigeras i slutet av oauth-flödet.

Svar

Name	Typ	Description
200 OK	string	Framgång
Other Status Codes	ErrorResponse	Fel Sidhuvuden x-ms-error-code: string

Säkerhet

Authorization

Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Typ: apiKey
I: header

Exempel

OAuthTokens_GetOAuthConnectionLink

Exempelbegäran

HTTP

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

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

Exempelsvar

Statuskod:

200

"Connection string"

Definitioner

Name	Description
Error	Ett fel från Azure AgPlatform-tjänsten.
ErrorResponse	Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokumentet.
InnerError	Inre fel som innehåller en lista över fel. Se referensdokumentet https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object för InnerError.
OAuthConnectRequest	Hämta frågeparametrar för OAuth-konfiguration.

Error

Objekt

Ett fel från Azure AgPlatform-tjänsten.

Name	Typ	Description
code	string minLength: 1	Serverdefinierad uppsättning felkoder.
details	Error[]	Matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerError	Inre fel som innehåller en lista över fel. Se referensdokumentet https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object för InnerError.
message	string minLength: 1	Mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorResponse

Objekt

Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokumentet.

Name	Typ	Description
error	Error	Ett fel från Azure AgPlatform-tjänsten.
traceId	string	Unikt spårnings-ID.

InnerError

Objekt

Inre fel som innehåller en lista över fel. Se referensdokumentet https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object för InnerError.

Name	Typ	Description
code	string	Specifik felkod än vad som angavs av det innehållande felet.
innererror	InnerError	Inre fel som innehåller en lista över fel. Se referensdokumentet https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object för InnerError.

OAuthConnectRequest

Objekt

Hämta frågeparametrar för OAuth-konfiguration.

Name	Typ	Description
oAuthProviderId	string minLength: 1	ID för OAuthProvider.
partyId	string minLength: 1	Id för festen.
userRedirectLink	string minLength: 0 maxLength: 1000	Länk för att omdirigera användaren till i slutet av oauth-flödet.
userRedirectState	string minLength: 0 maxLength: 200	Tillstånd att ange när användaren omdirigeras i slutet av oauth-flödet.