Users - List
Uygulamadaki kullanıcıların listesini alma
GET https://{subdomain}.{baseDomain}/api/users?api-version=2022-07-31
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
base
|
path | True |
string |
Tüm Azure IoT Central hizmet istekleri için temel etki alanı. |
subdomain
|
path | True |
string |
Uygulama alt etki alanı. |
api-version
|
query | True |
string |
Çağrılan API'nin sürümü. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Başarı |
|
Other Status Codes |
IoT Central Hizmetinden alınan bir hata yanıtı. Üst Bilgiler x-ms-error-code: string |
Güvenlik
azure_auth
Azure Active Directory OAuth2 Akışı
Tür:
oauth2
Akış:
implicit
Yetkilendirme URL’si:
https://login.microsoftonline.com/common/oauth2/authorize
Kapsamlar
Name | Description |
---|---|
user_impersonation | kullanıcı hesabınızın kimliğine bürünme |
Örnekler
List users
Örnek isteği
GET https://appsubdomain.azureiotcentral.com/api/users?api-version=2022-07-31
Örnek yanıt
{
"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"
}
]
}
Tanımlar
Name | Description |
---|---|
ADGroup |
Active Directory grubu kullanıcı tanımı. |
Email |
E-posta kullanıcı tanımı. |
Error |
Yanıt hatası tanımı. |
Error |
Hatanın ayrıntılı bilgileri. |
Role |
Rol atama tanımı. |
Service |
Hizmet sorumlusu kullanıcı tanımı. |
User |
Kullanıcıların sayfalanan sonuçları. |
ADGroupUser
Active Directory grubu kullanıcı tanımı.
Name | Tür | Description |
---|---|---|
id |
string |
Kullanıcının benzersiz kimliği. |
objectId |
string |
AD Grubunun AAD nesne kimliği. |
roles |
Uygulamaya erişim izinlerini belirten rol atamalarının listesi. |
|
tenantId |
string |
AD Grubunun AAD kiracı kimliği. |
type |
string:
ad |
Kullanıcının türü. |
EmailUser
E-posta kullanıcı tanımı.
Name | Tür | Description |
---|---|---|
string |
Kullanıcının e-posta adresi. |
|
id |
string |
Kullanıcının benzersiz kimliği. |
roles |
Uygulamaya erişim izinlerini belirten rol atamalarının listesi. |
|
type |
string:
|
Kullanıcının türü. |
Error
Yanıt hatası tanımı.
Name | Tür | Description |
---|---|---|
error |
Geçerli istek için hata ayrıntıları. |
ErrorDetails
Hatanın ayrıntılı bilgileri.
Name | Tür | Description |
---|---|---|
code |
string |
Hata kodu. |
message |
string |
Hata iletisi ayrıntıları. |
requestId |
string |
Geçerli istek için bağıntı kimliği. |
time |
string (date-time-rfc1123) |
Hata isteğinin başarısız olduğu zaman. |
RoleAssignment
Rol atama tanımı.
Name | Tür | Description |
---|---|---|
organization |
string |
Bu rol ataması için kuruluşun kimliği. |
role |
string |
Bu rol ataması için rolün kimliği. |
ServicePrincipalUser
Hizmet sorumlusu kullanıcı tanımı.
Name | Tür | Description |
---|---|---|
id |
string |
Kullanıcının benzersiz kimliği. |
objectId |
string |
Hizmet sorumlusunun AAD nesne kimliği. |
roles |
Uygulamaya erişim izinlerini belirten rol atamalarının listesi. |
|
tenantId |
string |
Hizmet sorumlusunun AAD kiracı kimliği. |
type |
string:
service |
Kullanıcının türü. |
UserCollection
Kullanıcıların sayfalanan sonuçları.
Name | Tür | Description |
---|---|---|
nextLink |
string |
Kullanıcıların sonraki sayfasını almak için URL. |
value | User[]: |
Kullanıcı koleksiyonu. |