Users - Create

Service:

IoT Central

API Version:

2022-07-31

Creación de un usuario en la aplicación

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
baseDomain	path	True	string	Dominio base para todas las solicitudes de servicio de Azure IoT Central.
subdomain	path	True	string	Subdominio de aplicación.
userId	path	True	string	Identificador único para el usuario. Regex pattern: ^[a-zA-Z0-9-_]*$
api-version	query	True	string	Versión de la API a la que se llama.

Cuerpo de la solicitud

El cuerpo de la solicitud puede ser uno de los siguientes:

Nombre	Description
ADGroupUser	Definición de usuario del grupo de Active Directory.
EmailUser	Definición de usuario de correo electrónico.
ServicePrincipalUser	Definición de usuario de la entidad de servicio.

ADGroupUser

Definición de usuario del grupo de Active Directory.

Nombre	Requerido	Tipo	Description
objectId	True	string	Identificador de objeto de AAD del grupo de AD.
roles	True	RoleAssignment[]	Lista de asignaciones de roles que especifican los permisos para acceder a la aplicación.
tenantId	True	string	Identificador de inquilino de AAD del grupo de AD.
type	True	string: adGroup	Tipo del usuario.

EmailUser

Definición de usuario de correo electrónico.

Nombre	Requerido	Tipo	Description
email	True	string	Dirección de correo electrónico del usuario.
roles	True	RoleAssignment[]	Lista de asignaciones de roles que especifican los permisos para acceder a la aplicación.
type	True	string: email	Tipo del usuario.

ServicePrincipalUser

Definición de usuario de la entidad de servicio.

Nombre	Requerido	Tipo	Description
objectId	True	string	Identificador de objeto de AAD de la entidad de servicio.
roles	True	RoleAssignment[]	Lista de asignaciones de roles que especifican los permisos para acceder a la aplicación.
tenantId	True	string	Identificador de inquilino de AAD de la entidad de servicio.
type	True	string: servicePrincipal	Tipo del usuario.

Respuestas

Nombre	Tipo	Description
200 OK	User: ADGroupUser EmailUser ServicePrincipalUser	Correcto
Other Status Codes	Error	Respuesta de error recibida del servicio IoT Central. Headers x-ms-error-code: string

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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

Definiciones

Nombre	Description
ADGroupUser	Definición de usuario del grupo de Active Directory.
EmailUser	Definición de usuario de correo electrónico.
Error	Definición de error de respuesta.
ErrorDetails	Información detallada del error.
RoleAssignment	Definición de asignación de roles.
ServicePrincipalUser	Definición de usuario de la entidad de servicio.

ADGroupUser

Definición de usuario del grupo de Active Directory.

Nombre	Tipo	Description
id	string	Identificador único del usuario.
objectId	string	Identificador de objeto de AAD del grupo de AD.
roles	RoleAssignment[]	Lista de asignaciones de roles que especifican los permisos para acceder a la aplicación.
tenantId	string	Identificador de inquilino de AAD del grupo de AD.
type	string: adGroup	Tipo del usuario.

EmailUser

Definición de usuario de correo electrónico.

Nombre	Tipo	Description
email	string	Dirección de correo electrónico del usuario.
id	string	Identificador único del usuario.
roles	RoleAssignment[]	Lista de asignaciones de roles que especifican los permisos para acceder a la aplicación.
type	string: email	Tipo del usuario.

Error

Definición de error de respuesta.

Nombre	Tipo	Description
error	ErrorDetails	Detalles del error para la solicitud actual.

ErrorDetails

Información detallada del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Detalles del mensaje de error.
requestId	string	Id. de correlación para la solicitud actual.
time	string	Hora en que se produjo un error en la solicitud de error.

RoleAssignment

Definición de asignación de roles.

Nombre	Tipo	Description
organization	string	Identificador de la organización para esta asignación de roles.
role	string	Identificador del rol para esta asignación de roles.

ServicePrincipalUser

Definición de usuario de la entidad de servicio.

Nombre	Tipo	Description
id	string	Identificador único del usuario.
objectId	string	Identificador de objeto de AAD de la entidad de servicio.
roles	RoleAssignment[]	Lista de asignaciones de roles que especifican los permisos para acceder a la aplicación.
tenantId	string	Identificador de inquilino de AAD de la entidad de servicio.
type	string: servicePrincipal	Tipo del usuario.