O Auth Providers - Get
Szerezzen be egy megadott oauthProvider-erőforrást.
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 állomásneve, például admaInstanceName.farmbeats.azure.net |
oauth
|
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 |
Success |
|
Other Status Codes |
Hiba Headers 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.
Type:
apiKey
In:
header
Példák
OAuthProviders_Get
Sample Request
GET {endpoint}/oauth/providers/JOHNDEERE?api-version=2023-11-01-preview
Sample Response
{
"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. |
Error |
Hibaválasz az Azure AgPlatform szolgáltatástól. Lásd https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses : ErrorResponse referenciadokumentum. |
Inner |
A hibák listáját tartalmazó belső hiba. Lásd: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError referenciadokumentum. |
OAuth |
Az OAuth-szolgáltatói erőforrás sémája. |
Error
Az Azure AgPlatform szolgáltatás hibája.
Name | Típus | Description |
---|---|---|
code |
string |
Kiszolgáló által definiált hibakódok. |
details |
Error[] |
A jelentett hibához vezető konkrét hibák részleteinek tömbje. |
innererror |
A hibák listáját tartalmazó belső hiba. Lásd: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError referenciadokumentum. |
|
message |
string |
A hiba emberi olvasásra alkalmas ábrázolása. |
target |
string |
A hiba célja. |
ErrorResponse
Hibaválasz az Azure AgPlatform szolgáltatástól. Lásd https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses : ErrorResponse referenciadokumentum.
Name | Típus | Description |
---|---|---|
error |
Az Azure AgPlatform szolgáltatás hibája. |
|
traceId |
string |
Egyedi nyomkövetési azonosító. |
InnerError
A hibák listáját tartalmazó belső hiba. Lásd: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError referenciadokumentum.
Name | Típus | Description |
---|---|---|
code |
string |
A hibát tartalmazó hiba által megadott hibakód. |
innererror |
A hibák listáját tartalmazó belső hiba. Lásd: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError referenciadokumentum. |
OAuthProvider
Az OAuth-szolgáltatói erőforrás sémája.
Name | Típus | Alapértelmezett érték | Description |
---|---|---|---|
apiKey |
string |
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 |
Adott OAuth-szolgáltató OAuth-alkalmazásazonosítója. |
|
appSecret |
string |
OAuth-alkalmazáskulcs adott szolgáltatóhoz. Megjegyzés: A rendszer nem küldi el válaszként. |
|
createdBy |
string |
A felhasználó/bérlő azonosítója hozza létre. |
|
createdDateTime |
string |
Az erőforrás létrehozásának dátuma és időpontja, mintaformátum: yyyy-MM-ddTHH:mm:ssZ. |
|
description |
string |
Az erőforrás szöveges leírása. |
|
eTag |
string |
Az optimista egyidejűség megvalósításához szükséges ETag érték. |
|
id |
string |
Egyedi OAuth-szolgáltatóazonosító. |
|
isProductionApp |
boolean |
False |
Nem kötelező jelző annak megállapításához, hogy az alkalmazás készen áll-e az éles környezetekben 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ítja a felhasználó/bérlő azonosítója. |
|
modifiedDateTime |
string |
Az erőforrás utolsó módosításának dátuma és időpontja, mintaformátum: yyyy-MM-ddTHH:mm:ssZ. |
|
name |
string |
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. A párok nem tartalmazhatnak 50 karakternél hosszabb kulcsot, és nem lehetnek 150 karakternél hosszabbak. Megjegyzés: Egy erőforráshoz legfeljebb 25 kulcsértékpár adható meg, és csak sztring-, szám- és datetime (éééé-HH-nnH:mm:ssZ) értékek támogatottak. |