Users - Create

Serviço:: IoT Central

Versão da API:: 2022-07-31

Criar um usuário no aplicativo

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 todas as solicitações de serviço do Azure IoT Central.
subdomain	path	True	string	O subdomínio do aplicativo.
userId	path	True	string maxLength: 48 pattern: ^[a-zA-Z0-9-_]*$	ID exclusivo para o usuário.
api-version	query	True	string	A versão da API que está sendo chamada.

Corpo do Pedido

O corpo de pedido pode ser um dos seguintes:

Name	Description
ADGroupUser	A definição de usuário do grupo do Ative Directory.
EmailUser	A definição de usuário de e-mail.
ServicePrincipalUser	A definição de usuário da entidade de serviço.

ADGroupUser

A definição de usuário do grupo do Ative Directory.

Name	Necessário	Tipo	Description
objectId	True	string	A ID do objeto AAD do Grupo AD.
roles	True	RoleAssignment[]	Lista de atribuições de função que especificam as permissões para acessar o aplicativo.
tenantId	True	string	A ID do locatário do AAD do Grupo AD.
type	True	string: adGroup	Tipo de utilizador.

EmailUser

A definição de usuário de e-mail.

Name	Necessário	Tipo	Description
email	True	string	Endereço de e-mail do usuário.
roles	True	RoleAssignment[]	Lista de atribuições de função que especificam as permissões para acessar o aplicativo.
type	True	string: email	Tipo de utilizador.

ServicePrincipalUser

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

Name	Necessário	Tipo	Description
objectId	True	string	A ID do objeto AAD da entidade de serviço.
roles	True	RoleAssignment[]	Lista de atribuições de função que especificam as permissões para acessar o aplicativo.
tenantId	True	string	A ID do locatário do AAD da entidade de serviço.
type	True	string: servicePrincipal	Tipo de utilizador.

Respostas

Name	Tipo	Description
200 OK	User: ADGroupUser EmailUser ServicePrincipalUser	Sucesso
Other Status Codes	Error	Uma resposta de erro recebida do Serviço Central da IoT. Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

200 OK

User:

ADGroupUser
EmailUser
ServicePrincipalUser

Sucesso

Other Status Codes

Error

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

Cabeçalhos

x-ms-error-code: string

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name	Description
user_impersonation	personificar 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

HTTP

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

Código de estado:: 200

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

HTTP

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

Código de estado:: 200

{
  "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 usuário do grupo do Ative Directory.
EmailUser	A definição de usuário 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 usuário da entidade de serviço.

ADGroupUser

Object

A definição de usuário do grupo do Ative Directory.

Name	Tipo	Description
id	string	ID exclusivo do utilizador.
objectId	string	A ID do objeto AAD do Grupo AD.
roles	RoleAssignment[]	Lista de atribuições de função que especificam as permissões para acessar o aplicativo.
tenantId	string	A ID do locatário do AAD do Grupo AD.
type	string: adGroup	Tipo de utilizador.

EmailUser

Object

A definição de usuário de e-mail.

Name	Tipo	Description
email	string	Endereço de e-mail do usuário.
id	string	ID exclusivo do utilizador.
roles	RoleAssignment[]	Lista de atribuições de função que especificam as permissões para acessar o aplicativo.
type	string: email	Tipo de utilizador.

Error

Object

A definição de erro de resposta.

Name	Tipo	Description
error	ErrorDetails	Detalhes do erro para a solicitação atual.

ErrorDetails

Object

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 para a solicitação atual.
time	string (date-time-rfc1123)	A hora em que a solicitação de erro falhou.

RoleAssignment

Object

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

Object

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

Name	Tipo	Description
id	string	ID exclusivo do utilizador.
objectId	string	A ID do objeto AAD da entidade de serviço.
roles	RoleAssignment[]	Lista de atribuições de função que especificam as permissões para acessar o aplicativo.
tenantId	string	A ID do locatário do AAD da entidade de serviço.
type	string: servicePrincipal	Tipo de utilizador.