Users - Create

Service:: IoT Central

Version d'API:: 2022-07-31

Créer un utilisateur dans l’application

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
baseDomain	path	True	string	Domaine de base pour toutes les demandes de service Azure IoT Central.
subdomain	path	True	string	Sous-domaine de l’application.
userId	path	True	string maxLength: 48 pattern: ^[a-zA-Z0-9-_]*$	ID unique de l’utilisateur.
api-version	query	True	string	Version de l’API appelée.

Corps de la demande

Le corps de la requête peut être l’un des suivants :

Nom	Description
ADGroupUser	Définition de l’utilisateur du groupe Active Directory.
EmailUser	Définition de l’utilisateur de messagerie.
ServicePrincipalUser	Définition de l’utilisateur du principal de service.

ADGroupUser

Définition de l’utilisateur du groupe Active Directory.

Nom	Obligatoire	Type	Description
objectId	True	string	ID d’objet AAD du groupe AD.
roles	True	RoleAssignment[]	Liste des attributions de rôles qui spécifient les autorisations d’accès à l’application.
tenantId	True	string	ID de locataire AAD du groupe AD.
type	True	string: adGroup	Type de l’utilisateur.

EmailUser

Définition de l’utilisateur de messagerie.

Nom	Obligatoire	Type	Description
email	True	string	Email’adresse de l’utilisateur.
roles	True	RoleAssignment[]	Liste des attributions de rôles qui spécifient les autorisations d’accès à l’application.
type	True	string: email	Type de l’utilisateur.

ServicePrincipalUser

Définition de l’utilisateur du principal de service.

Nom	Obligatoire	Type	Description
objectId	True	string	ID d’objet AAD du principal de service.
roles	True	RoleAssignment[]	Liste des attributions de rôles qui spécifient les autorisations d’accès à l’application.
tenantId	True	string	ID de locataire AAD du principal de service.
type	True	string: servicePrincipal	Type de l’utilisateur.

Réponses

Nom	Type	Description
200 OK	User: ADGroupUser EmailUser ServicePrincipalUser	Succès
Other Status Codes	Error	Réponse d’erreur reçue du service IoT Central. En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

User:

ADGroupUser
EmailUser
ServicePrincipalUser

Succès

Other Status Codes

Error

Réponse d’erreur reçue du service IoT Central.

En-têtes

x-ms-error-code: string

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Add or update a service principal user

Add or update an email user

Add or update a service principal user

Exemple de requête

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

Exemple de réponse

Code d’état:: 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

Exemple de requête

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

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
ADGroupUser	Définition de l’utilisateur du groupe Active Directory.
EmailUser	Définition de l’utilisateur de messagerie.
Error	Définition de l’erreur de réponse.
ErrorDetails	Informations détaillées de l’erreur.
RoleAssignment	Définition de l’attribution de rôle.
ServicePrincipalUser	Définition de l’utilisateur du principal de service.

ADGroupUser

Object

Définition de l’utilisateur du groupe Active Directory.

Nom	Type	Description
id	string	Identifiant unique de l’utilisateur.
objectId	string	ID d’objet AAD du groupe AD.
roles	RoleAssignment[]	Liste des attributions de rôles qui spécifient les autorisations d’accès à l’application.
tenantId	string	ID de locataire AAD du groupe AD.
type	string: adGroup	Type de l’utilisateur.

EmailUser

Object

Définition de l’utilisateur de messagerie.

Nom	Type	Description
email	string	Email’adresse de l’utilisateur.
id	string	Identifiant unique de l’utilisateur.
roles	RoleAssignment[]	Liste des attributions de rôles qui spécifient les autorisations d’accès à l’application.
type	string: email	Type de l’utilisateur.

Error

Object

Définition de l’erreur de réponse.

Nom	Type	Description
error	ErrorDetails	Détails de l’erreur pour la requête actuelle.

ErrorDetails

Object

Informations détaillées de l’erreur.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Détails du message d’erreur.
requestId	string	ID de corrélation pour la requête actuelle.
time	string (date-time-rfc1123)	Heure à laquelle la demande d’erreur a échoué.

RoleAssignment

Object

Définition de l’attribution de rôle.

Nom	Type	Description
organization	string	ID de l’organisation pour cette attribution de rôle.
role	string	ID du rôle pour cette attribution de rôle.

ServicePrincipalUser

Object

Définition de l’utilisateur du principal de service.

Nom	Type	Description
id	string	Identifiant unique de l’utilisateur.
objectId	string	ID d’objet AAD du principal de service.
roles	RoleAssignment[]	Liste des attributions de rôles qui spécifient les autorisations d’accès à l’application.
tenantId	string	ID de locataire AAD du principal de service.
type	string: servicePrincipal	Type de l’utilisateur.