Users - List

Obter a lista de usuários em um aplicativo

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

Parâmetros de URI

Name In Required Type Description
baseDomain
path True
  • string

O domínio base para todas as solicitações de serviço do Azure IoT Central.

subdomain
path True
  • string

O subdomínio do aplicativo.

api-version
query True
  • string

A versão da API que está sendo chamada.

Respostas

Name Type Description
200 OK

Êxito

Other Status Codes

Uma resposta de erro recebida do Serviço Central de IoT.

Headers

  • x-ms-error-code: string

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

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

Definições

ADGroupUser

A definição de usuário do grupo do active directory.

EmailUser

A definição do usuário de email.

Error

A definição de erro de resposta.

ErrorDetails

As informações detalhadas do erro.

RoleAssignment

A definição de atribuição de função.

ServicePrincipalUser

A definição de usuário da entidade de serviço.

UserCollection

Os resultados de páginas dos usuários.

ADGroupUser

A definição de usuário do grupo do active directory.

Name Type Description
id
  • string

ID exclusiva do usuário.

objectId
  • string

A ID do objeto AAD do Grupo do AD.

roles

Lista de atribuições de função que especificam as permissões para acessar o aplicativo.

tenantId
  • string

A ID de locatário do AAD do Grupo do AD.

type string:
  • adGroup

Tipo de usuário.

EmailUser

A definição do usuário de email.

Name Type Description
email
  • string

Endereço de email do usuário.

id
  • string

ID exclusiva do usuário.

roles

Lista de atribuições de função que especificam as permissões para acessar o aplicativo.

type string:
  • email

Tipo de usuário.

Error

A definição de erro de resposta.

Name Type Description
error

Detalhes do erro da solicitação atual.

ErrorDetails

As informações detalhadas do erro.

Name Type Description
code
  • string

Código do erro.

message
  • string

Detalhes da mensagem de erro.

requestId
  • string

ID de correlação para a solicitação atual.

time
  • string

A hora em que a solicitação de erro falhou.

RoleAssignment

A definição de atribuição de função.

Name Type Description
organization
  • string

ID da organização para essa atribuição de função.

role
  • string

ID da função para essa atribuição de função.

ServicePrincipalUser

A definição de usuário da entidade de serviço.

Name Type Description
id
  • string

ID exclusiva do usuário.

objectId
  • string

A ID do objeto AAD da entidade de serviço.

roles

Lista de atribuições de função que especificam as permissões para acessar o aplicativo.

tenantId
  • string

A ID de locatário do AAD da entidade de serviço.

type string:
  • servicePrincipal

Tipo de usuário.

UserCollection

Os resultados de páginas dos usuários.

Name Type Description
nextLink
  • string

URL para obter a próxima página de usuários.

value User[]:

A coleção de usuários.