O Auth Tokens - Get O Auth Connection Link

Serviço:

Azure Data Manager for Agriculture

Versão da API:

2023-11-01-preview

Retorna o link conexão necessário no fluxo OAuth.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string uri	O nome do host do namespace, por exemplo, admaInstanceName.farmbeats.azure.net
api-version	query	True	string	A versão da API solicitada

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	True	string	Forneça um token de portador válido para chamadas de API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você já tentou chamadas não autenticadas antes.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
oAuthProviderId	True	string	Id do OAuthProvider.
partyId	True	string	Id da festa.
userRedirectLink	True	string	Link para redirecionar o usuário para, no final do fluxo de oauth.
userRedirectState		string	Estado a ser fornecido novamente ao redirecionar o usuário, no final do fluxo de oauth.

Respostas

Nome	Tipo	Description
200 OK	string	Êxito
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 de API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você já tentou chamadas não autenticadas antes.

Tipo: apiKey
Em: header

Exemplos

OAuthTokens_GetOAuthConnectionLink

Solicitação de exemplo

HTTP

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

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

Resposta de exemplo

Código de status:

200

"Connection string"

Definições

Nome	Description
Error	Um erro do serviço AgPlatform do Azure.
ErrorResponse	Uma resposta de erro do serviço Azure AgPlatform. Consulte 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. Consulte 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 do OAuth.

Error

Um erro do serviço AgPlatform do Azure.

Nome	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 esse erro relatado.
innererror	InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.
message	string	Representação legível ao olho humano do erro.
target	string	Destino do erro.

ErrorResponse

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

Nome	Tipo	Description
error	Error	Um erro do serviço AgPlatform do Azure.
traceId	string	ID de rastreamento exclusiva.

InnerError

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

Nome	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. Consulte 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 do OAuth.

Nome	Tipo	Description
oAuthProviderId	string	Id do OAuthProvider.
partyId	string	Id da festa.
userRedirectLink	string	Link para redirecionar o usuário para, no final do fluxo de oauth.
userRedirectState	string	Estado a ser fornecido novamente ao redirecionar o usuário, no final do fluxo de oauth.