Users - List

Ottenere l'elenco di utenti in un'applicazione

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

Parametri dell'URI

Name In Required Type Description
baseDomain
path True
  • string

Dominio di base per tutte le richieste di servizio di Azure IoT Central.

subdomain
path True
  • string

Sottodominio dell'applicazione.

api-version
query True
  • string

Versione dell'API chiamata.

Risposte

Name Type Description
200 OK

Operazione riuscita

Other Status Codes

Risposta di errore ricevuta dal servizio IoT Central.

Headers

  • x-ms-error-code: string

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation rappresentare l'account utente

Esempio

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"
    }
  ]
}

Definizioni

ADGroupUser

Definizione dell'utente del gruppo di Active Directory.

EmailUser

Definizione dell'utente di posta elettronica.

Error

Definizione dell'errore di risposta.

ErrorDetails

Informazioni dettagliate sull'errore.

RoleAssignment

Definizione dell'assegnazione di ruolo.

ServicePrincipalUser

Definizione utente dell'entità servizio.

UserCollection

Risultati di paging degli utenti.

ADGroupUser

Definizione dell'utente del gruppo di Active Directory.

Name Type Description
id
  • string

ID univoco dell'utente.

objectId
  • string

ID oggetto AAD del gruppo di Active Directory.

roles

Elenco di assegnazioni di ruolo che specificano le autorizzazioni per accedere all'applicazione.

tenantId
  • string

ID tenant di AAD del gruppo di Active Directory.

type string:
  • adGroup

Tipo di utente.

EmailUser

Definizione dell'utente di posta elettronica.

Name Type Description
email
  • string

Indirizzo di posta elettronica dell'utente.

id
  • string

ID univoco dell'utente.

roles

Elenco di assegnazioni di ruolo che specificano le autorizzazioni per accedere all'applicazione.

type string:
  • email

Tipo di utente.

Error

Definizione dell'errore di risposta.

Name Type Description
error

Dettagli dell'errore per la richiesta corrente.

ErrorDetails

Informazioni dettagliate sull'errore.

Name Type Description
code
  • string

Codice di errore.

message
  • string

Dettagli del messaggio di errore.

requestId
  • string

ID correlazione per la richiesta corrente.

time
  • string

Ora in cui la richiesta di errore non è riuscita.

RoleAssignment

Definizione dell'assegnazione di ruolo.

Name Type Description
organization
  • string

ID dell'organizzazione per questa assegnazione di ruolo.

role
  • string

ID del ruolo per questa assegnazione di ruolo.

ServicePrincipalUser

Definizione utente dell'entità servizio.

Name Type Description
id
  • string

ID univoco dell'utente.

objectId
  • string

ID oggetto AAD dell'entità servizio.

roles

Elenco di assegnazioni di ruolo che specificano le autorizzazioni per accedere all'applicazione.

tenantId
  • string

ID tenant di AAD dell'entità servizio.

type string:
  • servicePrincipal

Tipo di utente.

UserCollection

Risultati di paging degli utenti.

Name Type Description
nextLink
  • string

URL per ottenere la pagina successiva degli utenti.

value User[]:

Raccolta di utenti.