O Auth Providers - Get

Služba:

Azure Data Manager for Agriculture

Verze rozhraní API:

2023-11-01-preview

Získejte zadaný prostředek oauthProvider.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string uri	Název hostitele oboru názvů, například admaInstanceName.farmbeats.azure.net
oauthProviderId	path	True	string	ID prostředku oauthProvider.
api-version	query	True	string	Požadovaná verze rozhraní API

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string	Zadejte platný nosný token pro autorizovaná volání rozhraní API. Mějte na paměti, že pokud jste dříve zkoušeli neověřovaná volání, možná budete muset vymazat mezipaměť prohlížeče.

Odpovědi

Name	Typ	Description
200 OK	OAuthProvider	Success
Other Status Codes	ErrorResponse	Chybová Hlavičky x-ms-error-code: string

Zabezpečení

Authorization

Zadejte platný nosný token pro autorizovaná volání rozhraní API. Mějte na paměti, že pokud jste dříve zkoušeli neověřovaná volání, možná budete muset vymazat mezipaměť prohlížeče.

Typ: apiKey
V: header

Příklady

OAuthProviders_Get

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kó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"
  }
}

Definice

Name	Description
Error	Došlo k chybě ze služby Azure AgPlatform.
ErrorResponse	Chybová odpověď ze služby Azure AgPlatform. Projděte si https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses referenční dokument ErrorResponse.
InnerError	Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.
OAuthProvider	Schéma prostředku poskytovatele OAuth

Error

Došlo k chybě ze služby Azure AgPlatform.

Name	Typ	Description
code	string	Sada kódů chyb definovaná serverem.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerError	Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.
message	string	Pro člověka čitelná reprezentace chyby.
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď ze služby Azure AgPlatform. Projděte si https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses referenční dokument ErrorResponse.

Name	Typ	Description
error	Error	Došlo k chybě ze služby Azure AgPlatform.
traceId	string	Jedinečné ID trasování

InnerError

Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.

Name	Typ	Description
code	string	Konkrétní kód chyby, než byl poskytnut chybou obsahující chybu.
innererror	InnerError	Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.

OAuthProvider

Schéma prostředku poskytovatele OAuth

Name	Typ	Default value	Description
apiKey	string		Klíč rozhraní API OAuth pro daného zprostředkovatele. Poznámka: Aktuálně platí pro poskytovatele klimatu. Jako odpověď se neodesílají.
appId	string		ID aplikace OAuth pro daného poskytovatele OAuth
appSecret	string		Tajný kód aplikace OAuth pro daného poskytovatele Poznámka: Jako odpověď se neodesílají.
createdBy	string		Vytvořeno pomocí ID uživatele nebo tenanta.
createdDateTime	string		Datum a čas vytvoření prostředku, ukázkový formát: yyyy-MM-ddTHH:mm:ssZ.
description	string		Textový popis zdroje.
eTag	string		Hodnota ETag pro implementaci optimistické souběžnosti.
id	string		Jedinečné ID zprostředkovatele OAuth.
isProductionApp	boolean	False	Volitelný příznak, který určuje, jestli je aplikace připravená k použití v produkčních scénářích na straně poskytovatele. (Výchozí hodnota: false) Poznámka: Aktuálně platí pro JohnDeere.
modifiedBy	string		Upraveno podle ID uživatele nebo tenanta.
modifiedDateTime	string		Datum a čas poslední změny prostředku, ukázkový formát: rrrr-MM-ddTHH:mm:ssZ.
name	string		Název pro identifikaci prostředku.
properties			Kolekce párů hodnot klíčů, které patří do prostředku. Každý pár nesmí mít klíč větší než 50 znaků a hodnotu větší než 150 znaků. Poznámka: Pro prostředek je možné zadat maximálně 25 párů hodnot klíčů a podporují se pouze hodnoty string, numeral a datetime (yyyy-MM-ddTHH:mm:ssZ).