Partilhar via


Users - Create

Criar um utilizador na aplicação

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

Parâmetros do URI

Name Em Necessário Tipo Description
baseDomain
path True

string

O domínio base para todos os pedidos de serviço do Azure IoT Central.

subdomain
path True

string

O subdomínio da aplicação.

userId
path True

string

ID exclusivo do utilizador.

Padrão Regex: ^[a-zA-Z0-9-_]*$

api-version
query True

string

A versão da API que está a ser chamada.

Corpo do Pedido

O corpo de pedido pode ser um dos seguintes:

Name Description
ADGroupUser

A definição de utilizador do grupo do Active Directory.

EmailUser

A definição de utilizador de e-mail.

ServicePrincipalUser

A definição de utilizador do principal de serviço.

ADGroupUser

A definição de utilizador do grupo do Active Directory.

Name Necessário Tipo Description
objectId True

string

O ID de objeto do AAD do Grupo do AD.

roles True

RoleAssignment[]

Lista de atribuições de funções que especificam as permissões para aceder à aplicação.

tenantId True

string

O ID de inquilino do AAD do Grupo do AD.

type True string:

adGroup

Tipo de utilizador.

EmailUser

A definição de utilizador de e-mail.

Name Necessário Tipo Description
email True

string

Endereço de e-mail do utilizador.

roles True

RoleAssignment[]

Lista de atribuições de funções que especificam as permissões para aceder à aplicação.

type True string:

email

Tipo de utilizador.

ServicePrincipalUser

A definição de utilizador do principal de serviço.

Name Necessário Tipo Description
objectId True

string

O ID de objeto do AAD do principal de serviço.

roles True

RoleAssignment[]

Lista de atribuições de funções que especificam as permissões para aceder à aplicação.

tenantId True

string

O ID de inquilino do AAD do principal de serviço.

type True string:

servicePrincipal

Tipo de utilizador.

Respostas

Name Tipo Description
200 OK User:

Com êxito

Other Status Codes

Error

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

Cabeçalhos

x-ms-error-code: string

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

Add or update a service principal user
Add or update an email user

Add or update a service principal user

Pedido de amostra

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

Resposta da amostra

{
  "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

Pedido de amostra

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

Resposta da amostra

{
  "type": "email",
  "roles": [
    {
      "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
    },
    {
      "role": "c495eb57-eb18-489e-9802-62c474e5645c",
      "organization": "seattle"
    }
  ],
  "email": "bob@contoso.com"
}

Definições

Name Description
ADGroupUser

A definição de utilizador do grupo do Active Directory.

EmailUser

A definição de utilizador de e-mail.

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 utilizador do principal de serviço.

ADGroupUser

A definição de utilizador do grupo do Active Directory.

Name Tipo Description
id

string

ID exclusivo do utilizador.

objectId

string

O ID de objeto do AAD do Grupo do AD.

roles

RoleAssignment[]

Lista de atribuições de funções que especificam as permissões para aceder à aplicação.

tenantId

string

O ID de inquilino do AAD do Grupo do AD.

type string:

adGroup

Tipo de utilizador.

EmailUser

A definição de utilizador de e-mail.

Name Tipo Description
email

string

Endereço de e-mail do utilizador.

id

string

ID exclusivo do utilizador.

roles

RoleAssignment[]

Lista de atribuições de funções que especificam as permissões para aceder à aplicação.

type string:

email

Tipo de utilizador.

Error

A definição de erro de resposta.

Name Tipo Description
error

ErrorDetails

Detalhes do erro do pedido atual.

ErrorDetails

As informações detalhadas do erro.

Name Tipo Description
code

string

Código de erro.

message

string

Detalhes da mensagem de erro.

requestId

string

ID de correlação do pedido atual.

time

string

A hora em que o pedido de erro falhou.

RoleAssignment

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

Name Tipo Description
organization

string

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

role

string

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

ServicePrincipalUser

A definição de utilizador do principal de serviço.

Name Tipo Description
id

string

ID exclusivo do utilizador.

objectId

string

O ID de objeto do AAD do principal de serviço.

roles

RoleAssignment[]

Lista de atribuições de funções que especificam as permissões para aceder à aplicação.

tenantId

string

O ID de inquilino do AAD do principal de serviço.

type string:

servicePrincipal

Tipo de utilizador.