Users - List

Mendapatkan daftar pengguna dalam aplikasi

GET https://{subdomain}.{baseDomain}/api/users?api-version=2022-07-31

Parameter URI

Name In Required Type Description
baseDomain
path True
  • string

Domain dasar untuk semua permintaan layanan Azure IoT Central.

subdomain
path True
  • string

Subdomain aplikasi.

api-version
query True
  • string

Versi API yang dipanggil.

Respons

Name Type Description
200 OK

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

Name Description
user_impersonation meniru akun pengguna Anda

Contoh

List users

Sample Request

GET https://appsubdomain.azureiotcentral.com/api/users?api-version=2022-07-31

Sample Response

{
  "value": [
    {
      "id": "af0d5b8f-7a69-4521-868e-19745fae353f",
      "type": "email",
      "roles": [
        {
          "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
        }
      ],
      "email": "alice@contoso.com"
    },
    {
      "id": "123",
      "type": "servicePrincipal",
      "roles": [
        {
          "role": "c495eb57-eb18-489e-9802-62c474e5645c",
          "organization": "seattle"
        }
      ],
      "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
      "objectId": "9071c899-bce0-4862-b208-75dabae226a9"
    }
  ]
}

Definisi

ADGroupUser

Definisi pengguna grup direktori aktif.

EmailUser

Definisi pengguna email.

Error

Definisi kesalahan respons.

ErrorDetails

Informasi detail kesalahan.

RoleAssignment

Definisi penetapan peran.

ServicePrincipalUser

Definisi pengguna perwakilan layanan.

UserCollection

Hasil halaman pengguna.

ADGroupUser

Definisi pengguna grup direktori aktif.

Name Type Description
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:
  • adGroup

Jenis pengguna.

EmailUser

Definisi pengguna email.

Name Type Description
email
  • string

Email alamat pengguna.

id
  • string

ID unik pengguna.

roles

Daftar penetapan peran yang menentukan izin untuk mengakses aplikasi.

type string:
  • email

Jenis pengguna.

Error

Definisi kesalahan respons.

Name Type Description
error

Detail kesalahan untuk permintaan saat ini.

ErrorDetails

Informasi detail kesalahan.

Name Type Description
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.

Name Type Description
organization
  • string

ID organisasi untuk penetapan peran ini.

role
  • string

ID peran untuk penetapan peran ini.

ServicePrincipalUser

Definisi pengguna perwakilan layanan.

Name Type Description
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:
  • servicePrincipal

Jenis pengguna.

UserCollection

Hasil halaman pengguna.

Name Type Description
nextLink
  • string

URL untuk mendapatkan halaman pengguna berikutnya.

value User[]:

Kumpulan pengguna.