O Auth Providers - Create Or Update

Referenz

Dienst:: Azure Data Manager for Agriculture

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

Erstellt oder aktualisiert eine oauthProvider-Ressource.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string uri	Der Hostname des Namespace, z. B. admaInstanceName.farmbeats.azure.net
oauthProviderId	path	True	string	ID der oauthProvider-Ressource.
api-version	query	True	string	Die angeforderte API-Version

Anforderungsheader

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

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie möglicherweise Ihren Browsercache löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Anforderungstext

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

Name	Typ	Beschreibung
apiKey	string	OAuth-API-Schlüssel für den angegebenen Anbieter. Hinweis: Gilt derzeit für Klimaanbieter. Wird nicht als Antwort gesendet.
appId	string	OAuth-App ID für den angegebenen OAuth-Anbieter.
appSecret	string	OAuth-App Geheimnis für den jeweiligen Anbieter. Hinweis: Wird nicht als Antwort gesendet.
description	string	Textbeschreibung der Ressource.
isProductionApp	boolean	Ein optionales Flag, um zu bestimmen, ob die App für Produktionsszenarien auf der Anbieterseite verwendet werden kann oder nicht. (Standardwert: false) Hinweis: Gilt derzeit für JohnDeere.
name	string	Der Name zur Identifizierung der Ressource.
properties		Eine Sammlung von Schlüsselwertpaaren, die zur Ressource gehören. Jedes Paar darf keinen Schlüssel größer als 50 Zeichen haben und darf keinen Wert größer als 150 Zeichen haben. Hinweis: Für eine Ressource können maximal 25 Schlüsselwertpaare bereitgestellt werden, und es werden nur Zeichenfolgen-, Zahlen- und Datetime-Werte (JJJJ-MM-ddTHH:mm:ssZ) unterstützt.

Antworten

Name	Typ	Beschreibung
200 OK	OAuthProvider	Erfolg
201 Created	OAuthProvider	Erstellt
Other Status Codes	ErrorResponse	Fehler Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

OAuthProvider

Erfolg

201 Created

OAuthProvider

Erstellt

Other Status Codes

ErrorResponse

Fehler

Header

x-ms-error-code: string

Sicherheit

Authorization

Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie möglicherweise Ihren Browsercache löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Typ: apiKey
In: header

Beispiele

OAuthProviders_CreateOrUpdate

Beispielanforderung

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"
  }
}

Beispiel für eine Antwort

Statuscode:: 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"
}

Statuscode:: 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"
}

Definitionen

Name	Beschreibung
Error	Ein Fehler des Azure AgPlatform-Diensts.
ErrorResponse	Eine Fehlerantwort des Azure AgPlatform-Diensts. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses unter ErrorResponse-Referenzdokument.
InnerError	Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.
OAuthProvider	Schema der OAuth-Anbieterressource.

Error

Ein Fehler des Azure AgPlatform-Diensts.

Name	Typ	Beschreibung
code	string	Vom Server definierte Gruppe von Fehlercodes.
details	Error[]	Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerError	Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.
message	string	Lesbare Darstellung des Fehlers.
target	string	Ziel des Fehlers.

ErrorResponse

Eine Fehlerantwort des Azure AgPlatform-Diensts. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses unter ErrorResponse-Referenzdokument.

Name	Typ	Beschreibung
error	Error	Ein Fehler des Azure AgPlatform-Diensts.
traceId	string	Eindeutige Ablaufverfolgungs-ID.

InnerError

Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.

Name	Typ	Beschreibung
code	string	Spezifischer Fehlercode als vom enthaltenden Fehler bereitgestellt wurde.
innererror	InnerError	Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.

OAuthProvider

Schema der OAuth-Anbieterressource.

Name	Typ	Standardwert	Beschreibung
apiKey	string		OAuth-API-Schlüssel für den angegebenen Anbieter. Hinweis: Gilt derzeit für Klimaanbieter. Wird nicht als Antwort gesendet.
appId	string		OAuth-App ID für den angegebenen OAuth-Anbieter.
appSecret	string		OAuth-App Geheimnis für den jeweiligen Anbieter. Hinweis: Wird nicht als Antwort gesendet.
createdBy	string		Erstellt von Benutzer-/Mandanten-ID.
createdDateTime	string		Datum und Uhrzeit der Erstellung der Ressource, Beispielformat: jjjj-MM-ttTHH:mm:ssZ.
description	string		Textbeschreibung der Ressource.
eTag	string		Der ETag-Wert, um eine optimistische Parallelität zu implementieren.
id	string		Eindeutige OAuth-Anbieter-ID.
isProductionApp	boolean	False	Ein optionales Flag, um zu bestimmen, ob die App für Produktionsszenarien auf der Anbieterseite verwendet werden kann oder nicht. (Standardwert: false) Hinweis: Gilt derzeit für JohnDeere.
modifiedBy	string		Geändert durch Benutzer-/Mandanten-ID.
modifiedDateTime	string		Datum und Uhrzeit der letzten Änderung der Ressource, Beispielformat: jjjj-MM-ttTHH:mm:ssZ.
name	string		Der Name zur Identifizierung der Ressource.
properties			Eine Sammlung von Schlüsselwertpaaren, die zur Ressource gehören. Jedes Paar darf keinen Schlüssel größer als 50 Zeichen haben und darf keinen Wert größer als 150 Zeichen haben. Hinweis: Für eine Ressource können maximal 25 Schlüsselwertpaare bereitgestellt werden, und es werden nur Zeichenfolgen-, Zahlen- und Datetime-Werte (JJJJ-MM-ddTHH:mm:ssZ) unterstützt.

Freigeben über

O Auth Providers - Create Or Update

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

Authorization

Beispiele

OAuthProviders_CreateOrUpdate

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Error

ErrorResponse

InnerError

OAuthProvider

Zusätzliche Ressourcen