O Auth Tokens - Get O Auth Connection Link

Service:

Azure Data Manager for Agriculture

Version d'API:

2023-11-01-preview

Retourne le lien de connexion nécessaire dans le flux OAuth.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string uri	Nom d’hôte de l’espace de noms, par exemple admaInstanceName.farmbeats.azure.net
api-version	query	True	string	Version de l’API demandée

En-tête de la demande

Nom	Obligatoire	Type	Description
Authorization	True	string	Fournissez un jeton de porteur valide pour les appels d’API autorisés. Notez que vous devrez peut-être effacer le cache de votre navigateur si vous avez déjà essayé des appels non authentifiés.

Corps de la demande

Nom	Obligatoire	Type	Description
oAuthProviderId	True	string	ID du OAuthProvider.
partyId	True	string	ID de la partie.
userRedirectLink	True	string	Lien vers laquelle rediriger l’utilisateur à la fin du flux oauth.
userRedirectState		string	État à fournir lors de la redirection de l’utilisateur, à la fin du flux oauth.

Réponses

Nom	Type	Description
200 OK	string	Succès
Other Status Codes	ErrorResponse	Error En-têtes x-ms-error-code: string

Sécurité

Authorization

Fournissez un jeton de porteur valide pour les appels d’API autorisés. Notez que vous devrez peut-être effacer le cache de votre navigateur si vous avez déjà essayé des appels non authentifiés.

Type: apiKey
Dans: header

Exemples

OAuthTokens_GetOAuthConnectionLink

Exemple de requête

HTTP

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

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

Exemple de réponse

Code d’état:

200

"Connection string"

Définitions

Nom	Description
Error	Erreur du service Azure AgPlatform.
ErrorResponse	Réponse d’erreur du service Azure AgPlatform. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses le document de référence ErrorResponse.
InnerError	Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object le document de référence InnerError.
OAuthConnectRequest	Obtenir les paramètres de requête de configuration OAuth.

Error

Erreur du service Azure AgPlatform.

Nom	Type	Description
code	string	Ensemble de codes d’erreur définis par le serveur.
details	Error[]	Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	InnerError	Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object le document de référence InnerError.
message	string	Représentation contrôlable de visu de l’erreur.
target	string	Cible de l’erreur.

ErrorResponse

Réponse d’erreur du service Azure AgPlatform. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses le document de référence ErrorResponse.

Nom	Type	Description
error	Error	Erreur du service Azure AgPlatform.
traceId	string	ID de trace unique.

InnerError

Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object le document de référence InnerError.

Nom	Type	Description
code	string	Code d’erreur spécifique fourni par l’erreur contenant.
innererror	InnerError	Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object le document de référence InnerError.

OAuthConnectRequest

Obtenir les paramètres de requête de configuration OAuth.

Nom	Type	Description
oAuthProviderId	string	ID du OAuthProvider.
partyId	string	ID de la partie.
userRedirectLink	string	Lien vers laquelle rediriger l’utilisateur à la fin du flux oauth.
userRedirectState	string	État à fournir lors de la redirection de l’utilisateur, à la fin du flux oauth.