O Auth Tokens - Get O Auth Connection Link

Dienst:

Azure Data Manager for Agriculture

API-Version:

2023-11-01-preview

Gibt die verbindung zurück, die im OAuth-Fluss erforderlich ist.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Der Hostname des Namespaces, z. B. admaInstanceName.farmbeats.azure.net
api-version	query	True	string	Die angeforderte API-Version

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Anrufe ausprobiert haben.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
oAuthProviderId	True	string minLength: 1	ID des OAuthProviders.
partyId	True	string minLength: 1	ID der Partei.
userRedirectLink	True	string minLength: 0 maxLength: 1000	Link zum Umleiten des Benutzers an das Ende des Oauth-Flusses.
userRedirectState		string minLength: 0 maxLength: 200	Zustand, der beim Umleiten des Benutzers am Ende des Oauth-Flusses wieder bereitgestellt werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	string	Erfolg
Other Status Codes	ErrorResponse	Fehler Header x-ms-error-code: string

Sicherheit

Authorization

Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Anrufe ausprobiert haben.

Typ: apiKey
In: header

Beispiele

OAuthTokens_GetOAuthConnectionLink

Beispielanforderung

HTTP

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

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

Beispiel für eine Antwort

Statuscode:

200

"Connection string"

Definitionen

Name	Beschreibung
Error	Fehler des Azure AgPlatform-Diensts.
ErrorResponse	Eine Fehlerantwort des Azure AgPlatform-Diensts. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses für ErrorResponse-Referenzdokument.
InnerError	Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.
OAuthConnectRequest	Abrufen von OAuth-Konfigurationsabfrageparametern.

Error

Objekt

Fehler des Azure AgPlatform-Diensts.

Name	Typ	Beschreibung
code	string minLength: 1	Serverdefinierter Satz von Fehlercodes.
details	Error[]	Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerError	Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.
message	string minLength: 1	Lesbare Darstellung des Fehlers.
target	string	Ziel des Fehlers.

ErrorResponse

Objekt

Eine Fehlerantwort des Azure AgPlatform-Diensts. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses für ErrorResponse-Referenzdokument.

Name	Typ	Beschreibung
error	Error	Fehler des Azure AgPlatform-Diensts.
traceId	string	Eindeutige Ablaufverfolgungs-ID.

InnerError

Objekt

Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.

Name	Typ	Beschreibung
code	string	Spezifischer Fehlercode, der vom enthaltenden Fehler bereitgestellt wurde.
innererror	InnerError	Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.

OAuthConnectRequest

Objekt

Abrufen von OAuth-Konfigurationsabfrageparametern.

Name	Typ	Beschreibung
oAuthProviderId	string minLength: 1	ID des OAuthProviders.
partyId	string minLength: 1	ID der Partei.
userRedirectLink	string minLength: 0 maxLength: 1000	Link zum Umleiten des Benutzers an das Ende des Oauth-Flusses.
userRedirectState	string minLength: 0 maxLength: 200	Zustand, der beim Umleiten des Benutzers am Ende des Oauth-Flusses wieder bereitgestellt werden soll.