Users - Create

Service:

IoT Central

API Version:

2022-07-31

Criar um usuário no aplicativo

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

Parâmetros de URI

Nome	Em	Obrigató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	ID exclusiva para o usuário. Regex pattern: ^[a-zA-Z0-9-_]*$
api-version	query	True	string	A versão da API que está sendo chamada.

Corpo da solicitação

O corpo da solicitação pode ser um dos seguintes:

Nome	Description
ADGroupUser	A definição de usuário do grupo do Active Directory.
EmailUser	A definição do usuário de email.
ServicePrincipalUser	A definição de usuário da entidade de serviço.

ADGroupUser

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

Nome	Obrigatório	Tipo	Description
objectId	True	string	A ID do objeto do AAD do Grupo do 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 de locatário do AAD do Grupo do AD.
type	True	string: adGroup	Tipo do usuário.

EmailUser

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

Nome	Obrigatório	Tipo	Description
email	True	string	Endereço de email 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 do usuário.

ServicePrincipalUser

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

Nome	Obrigatório	Tipo	Description
objectId	True	string	A ID do objeto do 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 de locatário do AAD da entidade de serviço.
type	True	string: servicePrincipal	Tipo do usuário.

Respostas

Nome	Tipo	Description
200 OK	User: ADGroupUser EmailUser ServicePrincipalUser	Êxito
Other Status Codes	Error	Uma resposta de erro recebida do Serviço do IoT Central. Headers x-ms-error-code: string

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Add or update a service principal user

Add or update an email user

Add or update a service principal user

Sample Request

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

Sample Response

Status code:

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

Sample Request

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

Sample Response

Status code:

200

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

Definições

Nome	Description
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.

ADGroupUser

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

Nome	Tipo	Description
id	string	ID exclusiva do usuário.
objectId	string	A ID do objeto do AAD do Grupo do AD.
roles	RoleAssignment[]	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 do usuário.

EmailUser

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

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

Error

A definição de erro de resposta.

Nome	Tipo	Description
error	ErrorDetails	Detalhes do erro da solicitação atual.

ErrorDetails

As informações detalhadas do erro.

Nome	Tipo	Description
code	string	Código do erro.
message	string	Detalhes da mensagem de erro.
requestId	string	ID de correlação da 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.

Nome	Tipo	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.

Nome	Tipo	Description
id	string	ID exclusiva do usuário.
objectId	string	A ID do objeto do 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 de locatário do AAD da entidade de serviço.
type	string: servicePrincipal	Tipo do usuário.