Az IoT Central REST API használata felhasználók és szerepkörök kezelésére
Az IoT Central REST API lehetővé teszi az IoT Central-alkalmazásokkal integrálható ügyfélalkalmazások fejlesztését. A REST API-val kezelheti a felhasználókat és a szerepköröket az IoT Central-alkalmazásban.
Minden IoT Central REST API-híváshoz szükség van egy engedélyezési fejlécre. További információ: IoT Central REST API-hívások hitelesítése és engedélyezése.
Feljegyzés
A felhasználókon és szerepkörökön végzett műveleteket az IoT Central naplózási naplója rögzíti.
Az IoT Central REST API referenciadokumentációját az Azure IoT Central REST API-referenciájában találja.
Ha meg szeretné tudni, hogyan kezelheti a felhasználókat és a szerepköröket az IoT Central felhasználói felületén, olvassa el a Felhasználók és szerepkörök kezelése az IoT Central-alkalmazásban című témakört .
Szerepkörök kezelése
A REST API-val listázhatja az IoT Central-alkalmazásban definiált szerepköröket. A következő kéréssel lekérheti a szerepkör-azonosítók listáját az alkalmazásból:
GET https://{your app subdomain}.azureiotcentral.com/api/roles?api-version=2022-07-31
A kérésre adott válasz a következő példához hasonlít, amely a három beépített szerepkört és egy egyéni szerepkört tartalmazza:
{
"value": [
{
"id": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4",
"displayName": "Administrator"
},
{
"id": "ae2c9854-393b-4f97-8c42-479d70ce626e",
"displayName": "Operator"
},
{
"id": "344138e9-8de4-4497-8c54-5237e96d6aaf",
"displayName": "Builder"
},
{
"id": "16f8533f-6b82-478f-8ba8-7e676b541b1b",
"displayName": "Example custom role"
}
]
}
Feljegyzés
Ez a parancs csak az alkalmazáshoz társított szerepköröket jeleníti meg, egyéni szervezeti szintű szerepköröket nem.
Felhasználók kezelése
A REST API a következőket teszi lehetővé:
- Az alkalmazás felhasználóinak listázása
- Az egyes felhasználók adatainak lekérése
- Felhasználó létrehozása
- Felhasználó módosítása
- Felhasználó törlése
Felhasználók listázása
A következő kéréssel lekérheti a felhasználók listáját az alkalmazásból:
GET https://{your app subdomain}.azureiotcentral.com/api/users?api-version=2022-07-31
A kérésre adott válasz az alábbi példához hasonlóan néz ki. A szerepkörértékek azonosítják azt a szerepkör-azonosítót, amelyhez a felhasználó társítva van:
{
"value": [
{
"id": "91907508-04fe-4349-91b5-b872f3055a95",
"type": "email",
"roles": [
{
"role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
}
],
"email": "user1@contoso.com"
},
{
"id": "dc1c916b-a652-49ea-b128-7c465a54c759",
"type": "email",
"roles": [
{
"role": "ae2c9854-393b-4f97-8c42-479d70ce626e"
}
],
"email": "user2@contoso.com"
},
{
"id": "3ab9375e-d2d9-42da-b419-6ae86a938321",
"type": "email",
"roles": [
{
"role": "344138e9-8de4-4497-8c54-5237e96d6aaf"
}
],
"email": "user3@contoso.com"
},
{
"id": "fc5a250b-83fb-433d-892c-e0a144f68c2b",
"type": "email",
"roles": [
{
"role": "16f8533f-6b82-478f-8ba8-7e676b541b1b"
}
],
"email": "user4@contoso.com"
}
]
}
Felhasználó lekérése
Az alábbi kéréssel kérheti le egy adott felhasználó adatait az alkalmazásból:
GET https://{your app subdomain}.azureiotcentral.com/api/users/dc1c916b-a652-49ea-b128-7c465a54c759?api-version=2022-07-31
A kérésre adott válasz az alábbi példához hasonlóan néz ki. A szerepkör értéke azonosítja azt a szerepkör-azonosítót, amelyhez a felhasználó társítva van:
{
"id": "dc1c916b-a652-49ea-b128-7c465a54c759",
"type": "email",
"roles": [
{
"role": "ae2c9854-393b-4f97-8c42-479d70ce626e"
}
],
"email": "user2@contoso.com"
}
Felhasználó létrehozása
A következő kéréssel hozzon létre egy felhasználót az alkalmazásban. Az azonosítónak és az e-mailnek egyedinek kell lennie az alkalmazásban:
PUT https://{your app subdomain}.azureiotcentral.com/api/users/user-001?api-version=2022-07-31
A következő kérelemtörzsben az érték a role
korábban lekért operátori szerepkörhöz tartozik:
{
"id": "user-001",
"type": "email",
"roles": [
{
"role": "ae2c9854-393b-4f97-8c42-479d70ce626e"
}
],
"email": "user5@contoso.com"
}
A kérésre adott válasz az alábbi példához hasonlóan néz ki. A szerepkör értéke azonosítja, hogy a felhasználó melyik szerepkörhöz van társítva:
{
"id": "user-001",
"type": "email",
"roles": [
{
"role": "ae2c9854-393b-4f97-8c42-479d70ce626e"
}
],
"email": "user5@contoso.com"
}
Olyan egyszerű szolgáltatásfelhasználót is hozzáadhat, amely akkor hasznos, ha szolgáltatásnév-hitelesítést kell használnia a REST API-hívásokhoz. További információ: Egyszerű szolgáltatásfelhasználó hozzáadása vagy frissítése.
Felhasználó szerepkörének módosítása
A következő kéréssel módosíthatja a felhasználóhoz rendelt szerepkört. Ez a példa a korábban lekért szerkesztői szerepkör azonosítóját használja:
PATCH https://{your app subdomain}.azureiotcentral.com/api/users/user-001?api-version=2022-07-31
Kérelem törzse. Az érték a korábban lekért szerkesztői szerepkörhöz tartozik:
{
"roles": [
{
"role": "344138e9-8de4-4497-8c54-5237e96d6aaf"
}
]
}
A kérésre adott válasz a következő példához hasonlóan néz ki:
{
"id": "user-001",
"type": "email",
"roles": [
{
"role": "344138e9-8de4-4497-8c54-5237e96d6aaf"
}
],
"email": "user5@contoso.com"
}
Felhasználó törlése
A következő kéréssel törölhet egy felhasználót:
DELETE https://{your app subdomain}.azureiotcentral.com/api/users/user-001?api-version=2022-07-31
Következő lépések
Most, hogy megtanulta, hogyan kezelheti a felhasználókat és a szerepköröket a REST API-val, javasolt következő lépés az IoT Central REST API használata a szervezetek kezeléséhez.