O Auth Providers - Get

Szolgáltatás:

Azure Data Manager for Agriculture

API-verzió:

2023-11-01-preview

Egy megadott oauthProvider-erőforrás lekérése.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string (uri)	A névtér gazdagépneve, például admaInstanceName.farmbeats.azure.net
oauthProviderId	path	True	string	Az oauthProvider erőforrás azonosítója.
api-version	query	True	string	A kért API-verzió

Kérelem fejléce

Name	Kötelező	Típus	Description
Authorization	True	string	Adjon meg érvényes tulajdonosi jogkivonatot az engedélyezett API-hívásokhoz. Vegye figyelembe, hogy előfordulhat, hogy törölnie kell a böngésző gyorsítótárát, ha korábban nem hitelesített hívásokat próbált meg.

Válaszok

Name	Típus	Description
200 OK	OAuthProvider	Siker
Other Status Codes	ErrorResponse	Hiba Fejlécek x-ms-error-code: string

Biztonság

Authorization

Adjon meg érvényes tulajdonosi jogkivonatot az engedélyezett API-hívásokhoz. Vegye figyelembe, hogy előfordulhat, hogy törölnie kell a böngésző gyorsítótárát, ha korábban nem hitelesített hívásokat próbált meg.

Típus: apiKey
In: header

Példák

OAuthProviders_Get

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
Error	Az Azure AgPlatform szolgáltatás hibája.
ErrorResponse	Hibaválasz az Azure AgPlatform szolgáltatástól. Az ErrorResponse referenciadokumentumának https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
InnerError	A hibák listáját tartalmazó belső hiba. Lásd az InnerError-referenciadokumentum https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object.
OAuthProvider	OAuth-szolgáltatói erőforrás sémája.

Error

Objektum

Az Azure AgPlatform szolgáltatás hibája.

Name	Típus	Description
code	string minLength: 1	Kiszolgáló által definiált hibakódok.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerError	A hibák listáját tartalmazó belső hiba. Lásd az InnerError-referenciadokumentum https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object.
message	string minLength: 1	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

ErrorResponse

Objektum

Hibaválasz az Azure AgPlatform szolgáltatástól. Az ErrorResponse referenciadokumentumának https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Típus	Description
error	Error	Az Azure AgPlatform szolgáltatás hibája.
traceId	string	Egyedi nyomkövetési azonosító.

InnerError

Objektum

A hibák listáját tartalmazó belső hiba. Lásd az InnerError-referenciadokumentum https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object.

Name	Típus	Description
code	string	A hibát tartalmazó hiba által megadottnál meghatározott hibakód.
innererror	InnerError	A hibák listáját tartalmazó belső hiba. Lásd az InnerError-referenciadokumentum https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object.

OAuthProvider

Objektum

OAuth-szolgáltatói erőforrás sémája.

Name	Típus	Alapértelmezett érték	Description
apiKey	string minLength: 2 maxLength: 200		OAuth Api-kulcs adott szolgáltatóhoz. Megjegyzés: jelenleg az éghajlat-szolgáltatóra vonatkozik. A rendszer nem küldi el válaszként.
appId	string minLength: 2 maxLength: 200		OAuth-alkalmazásazonosító adott OAuth-szolgáltatóhoz.
appSecret	string minLength: 2 maxLength: 200		OAuth-alkalmazás titkos kódja adott szolgáltatóhoz. Megjegyzés: A rendszer nem válaszol.
createdBy	string		A felhasználó/bérlő azonosítója hozza létre.
createdDateTime	string (date-time)		Az erőforrás létrehozásának dátuma, mintaformátum: yyyy-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500		Az erőforrás szöveges leírása.
eTag	string		Az ETag értéke az optimista egyidejűség megvalósításához.
id	string		Egyedi OAuth-szolgáltató azonosítója.
isProductionApp	boolean	False	Választható jelölő annak megállapításához, hogy az alkalmazás készen áll-e az éles környezetben való használatra a szolgáltatói oldalon. (Alapértelmezett érték: false) Megjegyzés: Jelenleg a JohnDeere esetében alkalmazható.
modifiedBy	string		Módosítva a felhasználó/bérlő azonosítója.
modifiedDateTime	string (date-time)		Az erőforrás utolsó módosításának dátuma, mintaformátum: yyyy-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100		Az erőforrás azonosítására szolgáló név.
properties			Az erőforráshoz tartozó kulcsértékpárok gyűjteménye. Minden párnak nem lehet 50 karakternél nagyobb kulcsa, és nem lehet 150 karakternél nagyobb érték. Megjegyzés: Egy erőforráshoz legfeljebb 25 kulcsértékpár adható meg, és csak a sztring, a szám és a datetime (yyyy-MM-ddTHH:mm:ssZ) értékek támogatottak.