O Auth Providers - Get

Dienst:: Azure Data Manager for Agriculture

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

Rufen Sie eine angegebene oauthProvider-Ressource ab.

GET {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 Namespaces, z. B. admaInstanceName.farmbeats.azure.net
oauthProviderId	path	True	string	ID der oauthProvider-Ressource.
api-version	query	True	string	Die angeforderte API-Version

Anforderungsheader

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

Antworten

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

Name

Typ

Beschreibung

200 OK

OAuthProvider

Erfolg

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 ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Anrufe ausprobiert haben.

Typ: apiKey
In: header

Beispiele

OAuthProviders_Get

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "id": "JOHNDEERE",
  "eTag": "f8fad5b-d9cb-469f-a165-70867728950e",
  "createdDateTime": "2021-04-22T18:27:37Z",
  "modifiedDateTime": "2021-04-22T18:27:37Z",
  "name": "JD Integration",
  "description": "Oauth Flow",
  "properties": {
    "Party": "123"
  }
}

Definitionen

Name	Beschreibung
Error	Fehler des Azure AgPlatform-Diensts.
ErrorResponse	Eine Fehlerantwort des Azure AgPlatform-Diensts. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses für ErrorResponse-Referenzdokument.
InnerError	Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.
OAuthProvider	Schema der OAuth-Anbieterressource.

Error

Objekt

Fehler des Azure AgPlatform-Diensts.

Name	Typ	Beschreibung
code	string minLength: 1	Serverdefinierter Satz von Fehlercodes.
details	Error[]	Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerError	Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.
message	string minLength: 1	Lesbare Darstellung des Fehlers.
target	string	Ziel des Fehlers.

ErrorResponse

Objekt

Eine Fehlerantwort des Azure AgPlatform-Diensts. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses für ErrorResponse-Referenzdokument.

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

InnerError

Objekt

Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.

Name	Typ	Beschreibung
code	string	Spezifischer Fehlercode, der vom enthaltenden Fehler bereitgestellt wurde.
innererror	InnerError	Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.

OAuthProvider

Objekt

Schema der OAuth-Anbieterressource.

Name	Typ	Standardwert	Beschreibung
apiKey	string minLength: 2 maxLength: 200		OAuth-API-Schlüssel für einen bestimmten Anbieter. Hinweis: Derzeit gilt für Klimaanbieter. Wird nicht als Antwort gesendet.
appId	string minLength: 2 maxLength: 200		OAuth-App-ID für den angegebenen OAuth-Anbieter.
appSecret	string minLength: 2 maxLength: 200		OAuth-App-Geheimnis für den angegebenen Anbieter. Hinweis: Wird nicht als Antwort gesendet.
createdBy	string		Erstellt von der Benutzer-/Mandanten-ID.
createdDateTime	string (date-time)		Datum-Uhrzeit der Erstellung der Ressource, Beispielformat: yyyy-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500		Textbeschreibung der Ressource.
eTag	string		Der ETag-Wert, der optimistische Parallelität implementiert.
id	string		Eindeutige OAuth-Anbieter-ID.
isProductionApp	boolean	False	Ein optionales Kennzeichen, um festzustellen, ob die App für Produktionsszenarien auf der Anbieterseite verwendet werden kann oder nicht. (Standardwert: false) Hinweis: Derzeit gilt für JohnDeere.
modifiedBy	string		Geändert von Benutzer-/Mandanten-ID.
modifiedDateTime	string (date-time)		Datum-Uhrzeit der letzten Änderung der Ressource, Beispielformat: yyyy-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100		Name zum Identifizieren der Ressource.
properties			Eine Sammlung von Schlüsselwertpaaren, die zur Ressource gehören. Jedes Paar darf nicht über einen Schlüssel größer als 50 Zeichen verfügen 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-, Numeral- und Datetime-Werte (yyyy-MM-ddTHH:mm:ssZ) unterstützt.