O Auth Providers - Create Or Update

Référence

Service:: Azure Data Manager for Agriculture

Version d'API:: 2023-11-01-preview

Crée ou met à jour une ressource oauthProvider.

PATCH {endpoint}/oauth/providers/{oauthProviderId}?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
oauthProviderId	path	True	string	ID de la ressource oauthProvider.
api-version	query	True	string	Version de l’API demandée

En-tête de la demande

Media Types: "application/merge-patch+json"

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

Media Types: "application/merge-patch+json"

Nom	Type	Description
apiKey	string	Clé API OAuth pour un fournisseur donné. Remarque : actuellement applicable au fournisseur Climat. Ne sera pas envoyé en réponse.
appId	string	id Application OAuth pour un fournisseur OAuth donné.
appSecret	string	Application OAuth secret pour un fournisseur donné. Remarque : ne sera pas envoyé en réponse.
description	string	Description textuelle de la ressource.
isProductionApp	boolean	Indicateur facultatif permettant de déterminer si l’application est prête à être utilisée pour les scénarios de production côté fournisseur ou non. (Valeur par défaut : false) Remarque : Actuellement applicable à JohnDeere.
name	string	Nom destiné à identifier la ressource.
properties		Collection de paires clé-valeur qui appartient à la ressource. Chaque paire ne doit pas avoir une clé supérieure à 50 caractères et ne doit pas avoir une valeur supérieure à 150 caractères. Remarque : Un maximum de 25 paires de valeur de clé peut être fourni pour une ressource et seules les valeurs string, numeral et datetime (aaaa-MM-ddTHH :mm :ssZ) sont prises en charge.

Réponses

Nom	Type	Description
200 OK	OAuthProvider	Succès
201 Created	OAuthProvider	Date de création
Other Status Codes	ErrorResponse	Error En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

OAuthProvider

Succès

201 Created

OAuthProvider

Date de création

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

OAuthProviders_CreateOrUpdate

Exemple de requête

HTTP

PATCH {endpoint}/oauth/providers/JOHNDEERE?api-version=2023-11-01-preview

{
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "name": "JOHNDEERE",
  "description": "some description",
  "properties": {
    "orgId": "ORG123"
  }
}

Exemple de réponse

Code d’état:: 200

{
  "id": "JOHNDEERE",
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "name": "JOHNDEERE",
  "description": "some description",
  "properties": {
    "orgId": "ORG123"
  },
  "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "createdDateTime": "2021-04-23T11:31:10Z",
  "modifiedDateTime": "2021-04-23T11:31:10Z"
}

Code d’état:: 201

{
  "id": "JOHNDEERE",
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "name": "JOHNDEERE",
  "description": "some description",
  "properties": {
    "orgId": "ORG123"
  },
  "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "createdDateTime": "2021-04-23T11:31:10Z",
  "modifiedDateTime": "2021-04-23T11:31:10Z"
}

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.
OAuthProvider	Schéma de la ressource du fournisseur 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.

OAuthProvider

Schéma de la ressource du fournisseur OAuth.

Nom	Type	Valeur par défaut	Description
apiKey	string		Clé API OAuth pour un fournisseur donné. Remarque : actuellement applicable au fournisseur Climat. Ne sera pas envoyé en réponse.
appId	string		id Application OAuth pour un fournisseur OAuth donné.
appSecret	string		Application OAuth secret pour un fournisseur donné. Remarque : ne sera pas envoyé en réponse.
createdBy	string		Créé par l’ID utilisateur/locataire.
createdDateTime	string		Date/Heure de création de la ressource, exemple de format : aaaa-MM-jjTHH:mm:ssZ.
description	string		Description textuelle de la ressource.
eTag	string		Valeur ETag pour implémenter l’accès concurrentiel optimiste.
id	string		ID de fournisseur OAuth unique.
isProductionApp	boolean	False	Indicateur facultatif permettant de déterminer si l’application est prête à être utilisée pour les scénarios de production côté fournisseur ou non. (Valeur par défaut : false) Remarque : Actuellement applicable à JohnDeere.
modifiedBy	string		Modifié par l’ID utilisateur/locataire.
modifiedDateTime	string		Date/Heure de la dernière modification de la ressource, exemple de format : aaaa-MM-jjTHH:mm:ssZ.
name	string		Nom destiné à identifier la ressource.
properties			Collection de paires clé-valeur qui appartient à la ressource. Chaque paire ne doit pas avoir une clé supérieure à 50 caractères et ne doit pas avoir une valeur supérieure à 150 caractères. Remarque : Un maximum de 25 paires de valeur de clé peut être fourni pour une ressource et seules les valeurs string, numeral et datetime (aaaa-MM-ddTHH :mm :ssZ) sont prises en charge.

Partager via

O Auth Providers - Create Or Update

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

Authorization

Exemples

OAuthProviders_CreateOrUpdate

Exemple de requête

Exemple de réponse

Définitions

Error

ErrorResponse

InnerError

OAuthProvider

Ressources supplémentaires