Users - Create
Membuat pengguna dalam aplikasi
PUT https://{subdomain}.{baseDomain}/api/users/{userId}?api-version=2022-07-31
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
base
|
path | True |
string |
Domain dasar untuk semua permintaan layanan Azure IoT Central. |
subdomain
|
path | True |
string |
Subdomain aplikasi. |
user
|
path | True |
string |
ID unik untuk pengguna. Regex pattern: |
api-version
|
query | True |
string |
Versi API yang dipanggil. |
Isi Permintaan
Isi permintaan dapat berupa salah satu hal berikut:
Nama | Deskripsi |
---|---|
ADGroup |
Definisi pengguna grup direktori aktif. |
Email |
Definisi pengguna email. |
Service |
Definisi pengguna perwakilan layanan. |
ADGroupUser
Definisi pengguna grup direktori aktif.
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
objectId | True |
string |
ID objek AAD dari Grup AD. |
roles | True |
Daftar penetapan peran yang menentukan izin untuk mengakses aplikasi. |
|
tenantId | True |
string |
ID penyewa AAD dari Grup AD. |
type | True |
string:
ad |
Jenis pengguna. |
EmailUser
Definisi pengguna email.
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
True |
string |
Email alamat pengguna. |
|
roles | True |
Daftar penetapan peran yang menentukan izin untuk mengakses aplikasi. |
|
type | True |
string:
|
Jenis pengguna. |
ServicePrincipalUser
Definisi pengguna perwakilan layanan.
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
objectId | True |
string |
ID objek AAD dari perwakilan layanan. |
roles | True |
Daftar penetapan peran yang menentukan izin untuk mengakses aplikasi. |
|
tenantId | True |
string |
ID penyewa AAD dari perwakilan layanan. |
type | True |
string:
service |
Jenis pengguna. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK | User: |
Berhasil |
Other Status Codes |
Respons kesalahan diterima dari IoT Central Service. Headers x-ms-error-code: string |
Keamanan
azure_auth
Alur OAuth2 Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nama | Deskripsi |
---|---|
user_impersonation | meniru akun pengguna Anda |
Contoh
Add or update a service principal user |
Add or update an email user |
Add or update a service principal user
Sample Request
PUT https://appsubdomain.azureiotcentral.com/api/users/123?api-version=2022-07-31
{
"type": "servicePrincipal",
"tenantId": "027fdad7-cf0f-470a-a26a-272197813322",
"objectId": "65e13aac-1443-4c49-9d49-57b87197cfff",
"roles": [
{
"role": "c7be2c6b-797e-4551-bb24-33709f6b2e20"
},
{
"role": "c495eb57-eb18-489e-9802-62c474e5645c",
"organization": "seattle"
}
]
}
Sample Response
{
"id": "123",
"type": "servicePrincipal",
"tenantId": "027fdad7-cf0f-470a-a26a-272197813322",
"objectId": "65e13aac-1443-4c49-9d49-57b87197cfff",
"roles": [
{
"role": "c7be2c6b-797e-4551-bb24-33709f6b2e20"
},
{
"role": "c495eb57-eb18-489e-9802-62c474e5645c",
"organization": "seattle"
}
]
}
Add or update an email user
Sample Request
PUT https://appsubdomain.azureiotcentral.com/api/users/123?api-version=2022-07-31
{
"type": "email",
"roles": [
{
"role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
},
{
"role": "c495eb57-eb18-489e-9802-62c474e5645c",
"organization": "seattle"
}
],
"email": "bob@contoso.com"
}
Sample Response
{
"type": "email",
"roles": [
{
"role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
},
{
"role": "c495eb57-eb18-489e-9802-62c474e5645c",
"organization": "seattle"
}
],
"email": "bob@contoso.com"
}
Definisi
Nama | Deskripsi |
---|---|
ADGroup |
Definisi pengguna grup direktori aktif. |
Email |
Definisi pengguna email. |
Error |
Definisi kesalahan respons. |
Error |
Informasi detail kesalahan. |
Role |
Definisi penetapan peran. |
Service |
Definisi pengguna perwakilan layanan. |
ADGroupUser
Definisi pengguna grup direktori aktif.
Nama | Jenis | Deskripsi |
---|---|---|
id |
string |
ID unik pengguna. |
objectId |
string |
ID objek AAD dari Grup AD. |
roles |
Daftar penetapan peran yang menentukan izin untuk mengakses aplikasi. |
|
tenantId |
string |
ID penyewa AAD dari Grup AD. |
type |
string:
ad |
Jenis pengguna. |
EmailUser
Definisi pengguna email.
Nama | Jenis | Deskripsi |
---|---|---|
string |
Email alamat pengguna. |
|
id |
string |
ID unik pengguna. |
roles |
Daftar penetapan peran yang menentukan izin untuk mengakses aplikasi. |
|
type |
string:
|
Jenis pengguna. |
Error
Definisi kesalahan respons.
Nama | Jenis | Deskripsi |
---|---|---|
error |
Detail kesalahan untuk permintaan saat ini. |
ErrorDetails
Informasi detail kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
code |
string |
Kode Kesalahan. |
message |
string |
Detail pesan kesalahan. |
requestId |
string |
Id Korelasi untuk permintaan saat ini. |
time |
string |
Waktu permintaan kesalahan gagal. |
RoleAssignment
Definisi penetapan peran.
Nama | Jenis | Deskripsi |
---|---|---|
organization |
string |
ID organisasi untuk penetapan peran ini. |
role |
string |
ID peran untuk penetapan peran ini. |
ServicePrincipalUser
Definisi pengguna perwakilan layanan.
Nama | Jenis | Deskripsi |
---|---|---|
id |
string |
ID unik pengguna. |
objectId |
string |
ID objek AAD dari perwakilan layanan. |
roles |
Daftar penetapan peran yang menentukan izin untuk mengakses aplikasi. |
|
tenantId |
string |
ID penyewa AAD dari perwakilan layanan. |
type |
string:
service |
Jenis pengguna. |