O Auth Tokens - Get O Auth Connection Link

Usługa:

Azure Data Manager for Agriculture

Wersja interfejsu API:

2023-11-01-preview

Zwraca link Połączenie wymagane w przepływie protokołu OAuth.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (uri)	Nazwa hosta przestrzeni nazw, np. admaInstanceName.farmbeats.azure.net
api-version	query	True	string	Żądana wersja interfejsu API

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Podaj prawidłowy token elementu nośnego dla autoryzowanych wywołań interfejsu API. Pamiętaj, że może być konieczne wyczyszczenie pamięci podręcznej przeglądarki, jeśli wcześniej próbowano wykonać nieuwierzytelnione wywołania.

Treść żądania

Nazwa	Wymagane	Typ	Opis
oAuthProviderId	True	string minLength: 1	Identyfikator dostawcy OAuthProvider.
partyId	True	string minLength: 1	Identyfikator strony.
userRedirectLink	True	string minLength: 0 maxLength: 1000	Link umożliwiający przekierowanie użytkownika do strony na końcu przepływu oauth.
userRedirectState		string minLength: 0 maxLength: 200	Stan, który ma zostać przywrócony podczas przekierowywania użytkownika, na końcu przepływu oauth.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	string	Powodzenie
Other Status Codes	ErrorResponse	Błąd Nagłówki x-ms-error-code: string

Zabezpieczenia

Authorization

Podaj prawidłowy token elementu nośnego dla autoryzowanych wywołań interfejsu API. Pamiętaj, że może być konieczne wyczyszczenie pamięci podręcznej przeglądarki, jeśli wcześniej próbowano wykonać nieuwierzytelnione wywołania.

Typ: apiKey
W: header

Przykłady

OAuthTokens_GetOAuthConnectionLink

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:

200

"Connection string"

Definicje

Nazwa	Opis
Error	Błąd usługi Azure AgPlatform.
ErrorResponse	Odpowiedź na błąd z usługi Azure AgPlatform. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses, aby zapoznać się z dokumentem referencyjnym ErrorResponse.
InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object, aby zapoznać się z dokumentem referencyjnym InnerError.
OAuthConnectRequest	Pobieranie parametrów zapytania konfiguracji protokołu OAuth.

Error

Objekt

Błąd usługi Azure AgPlatform.

Nazwa	Typ	Opis
code	string minLength: 1	Zdefiniowany przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object, aby zapoznać się z dokumentem referencyjnym InnerError.
message	string minLength: 1	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd z usługi Azure AgPlatform. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses, aby zapoznać się z dokumentem referencyjnym ErrorResponse.

Nazwa	Typ	Opis
error	Error	Błąd usługi Azure AgPlatform.
traceId	string	Unikatowy identyfikator śledzenia.

InnerError

Objekt

Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object, aby zapoznać się z dokumentem referencyjnym InnerError.

Nazwa	Typ	Opis
code	string	Określony kod błędu niż został dostarczony przez błąd zawierający.
innererror	InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object, aby zapoznać się z dokumentem referencyjnym InnerError.

OAuthConnectRequest

Objekt

Pobieranie parametrów zapytania konfiguracji protokołu OAuth.

Nazwa	Typ	Opis
oAuthProviderId	string minLength: 1	Identyfikator dostawcy OAuthProvider.
partyId	string minLength: 1	Identyfikator strony.
userRedirectLink	string minLength: 0 maxLength: 1000	Link umożliwiający przekierowanie użytkownika do strony na końcu przepływu oauth.
userRedirectState	string minLength: 0 maxLength: 200	Stan, który ma zostać przywrócony podczas przekierowywania użytkownika, na końcu przepływu oauth.