O Auth Tokens - Get O Auth Connection Link

Serviço:

Azure Data Manager for Agriculture

Versão da API:

2023-11-01-preview

Devolve a ligação Ligação necessária no fluxo OAuth.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string uri	O nome do anfitrião do espaço de nomes, por exemplo, admaInstanceName.farmbeats.azure.net
api-version	query	True	string	A versão da API pedida

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Authorization	True	string	Forneça um token de portador válido para chamadas à API autorizadas. Tenha em atenção que poderá ter de limpar a cache do browser se já tiver tentado chamadas não autenticadas antes.

Corpo do Pedido

Name	Necessário	Tipo	Description
oAuthProviderId	True	string	ID do OAuthProvider.
partyId	True	string	ID da festa.
userRedirectLink	True	string	Ligação para redirecionar o utilizador para, no final do fluxo de oauth.
userRedirectState		string	Estado a indicar quando redirecionar o utilizador, no final do fluxo de oauth.

Respostas

Name	Tipo	Description
200 OK	string	Success
Other Status Codes	ErrorResponse	Erro Cabeçalhos x-ms-error-code: string

Segurança

Authorization

Forneça um token de portador válido para chamadas à API autorizadas. Tenha em atenção que poderá ter de limpar a cache do browser se já tiver tentado chamadas não autenticadas antes.

Tipo: apiKey
Em: header

Exemplos

OAuthTokens_GetOAuthConnectionLink

Pedido de amostra

HTTP

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

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

Resposta da amostra

Código de estado:

200

"Connection string"

Definições

Name	Description
Error	Um erro do serviço AgPlatform do Azure.
ErrorResponse	Uma resposta de erro do serviço Azure AgPlatform. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses o documento de referência ErrorResponse.
InnerError	Erro interno que contém a lista de erros. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.
OAuthConnectRequest	Obter parâmetros de consulta de configuração OAuth.

Error

Um erro do serviço AgPlatform do Azure.

Name	Tipo	Description
code	string	Conjunto definido pelo servidor de códigos de erro.
details	Error[]	Matriz de detalhes sobre erros específicos que levaram a este erro comunicado.
innererror	InnerError	Erro interno que contém a lista de erros. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.
message	string	Representação legível por humanos do erro.
target	string	Destino do erro.

ErrorResponse

Uma resposta de erro do serviço Azure AgPlatform. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses o documento de referência ErrorResponse.

Name	Tipo	Description
error	Error	Um erro do serviço AgPlatform do Azure.
traceId	string	ID de rastreio exclusivo.

InnerError

Erro interno que contém a lista de erros. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

Name	Tipo	Description
code	string	Código de erro específico do que foi fornecido pelo erro que contém.
innererror	InnerError	Erro interno que contém a lista de erros. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

OAuthConnectRequest

Obter parâmetros de consulta de configuração OAuth.

Name	Tipo	Description
oAuthProviderId	string	ID do OAuthProvider.
partyId	string	ID da festa.
userRedirectLink	string	Ligação para redirecionar o utilizador para, no final do fluxo de oauth.
userRedirectState	string	Estado a indicar quando redirecionar o utilizador, no final do fluxo de oauth.