Users - Create

Service:

IoT Central

API Version:

2022-07-31

Creare un utente nell'applicazione

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
baseDomain	path	True	string	Dominio di base per tutte le richieste di servizio di Azure IoT Central.
subdomain	path	True	string	Sottodominio dell'applicazione.
userId	path	True	string	ID univoco per l'utente. Regex pattern: ^[a-zA-Z0-9-_]*$
api-version	query	True	string	Versione dell'API chiamata.

Corpo della richiesta

Il corpo della richiesta può essere uno dei seguenti:

Nome	Descrizione
ADGroupUser	Definizione dell'utente del gruppo di Active Directory.
EmailUser	Definizione dell'utente di posta elettronica.
ServicePrincipalUser	Definizione utente dell'entità servizio.

ADGroupUser

Definizione dell'utente del gruppo di Active Directory.

Nome	Necessario	Tipo	Descrizione
objectId	True	string	ID oggetto AAD del gruppo di Active Directory.
roles	True	RoleAssignment[]	Elenco di assegnazioni di ruolo che specificano le autorizzazioni per accedere all'applicazione.
tenantId	True	string	ID tenant di AAD del gruppo di Active Directory.
type	True	string: adGroup	Tipo di utente.

EmailUser

Definizione dell'utente di posta elettronica.

Nome	Necessario	Tipo	Descrizione
email	True	string	Indirizzo di posta elettronica dell'utente.
roles	True	RoleAssignment[]	Elenco di assegnazioni di ruolo che specificano le autorizzazioni per accedere all'applicazione.
type	True	string: email	Tipo di utente.

ServicePrincipalUser

Definizione utente dell'entità servizio.

Nome	Necessario	Tipo	Descrizione
objectId	True	string	ID oggetto AAD dell'entità servizio.
roles	True	RoleAssignment[]	Elenco di assegnazioni di ruolo che specificano le autorizzazioni per accedere all'applicazione.
tenantId	True	string	ID tenant di AAD dell'entità servizio.
type	True	string: servicePrincipal	Tipo di utente.

Risposte

Nome	Tipo	Descrizione
200 OK	User: ADGroupUser EmailUser ServicePrincipalUser	Operazione riuscita
Other Status Codes	Error	Risposta di errore ricevuta dal servizio IoT Central. Headers x-ms-error-code: string

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Definizioni

Nome	Descrizione
ADGroupUser	Definizione dell'utente del gruppo di Active Directory.
EmailUser	Definizione dell'utente di posta elettronica.
Error	Definizione dell'errore di risposta.
ErrorDetails	Informazioni dettagliate sull'errore.
RoleAssignment	Definizione dell'assegnazione di ruolo.
ServicePrincipalUser	Definizione utente dell'entità servizio.

ADGroupUser

Definizione dell'utente del gruppo di Active Directory.

Nome	Tipo	Descrizione
id	string	ID univoco dell'utente.
objectId	string	ID oggetto AAD del gruppo di Active Directory.
roles	RoleAssignment[]	Elenco di assegnazioni di ruolo che specificano le autorizzazioni per accedere all'applicazione.
tenantId	string	ID tenant di AAD del gruppo di Active Directory.
type	string: adGroup	Tipo di utente.

EmailUser

Definizione dell'utente di posta elettronica.

Nome	Tipo	Descrizione
email	string	Indirizzo di posta elettronica dell'utente.
id	string	ID univoco dell'utente.
roles	RoleAssignment[]	Elenco di assegnazioni di ruolo che specificano le autorizzazioni per accedere all'applicazione.
type	string: email	Tipo di utente.

Error

Definizione dell'errore di risposta.

Nome	Tipo	Descrizione
error	ErrorDetails	Dettagli dell'errore per la richiesta corrente.

ErrorDetails

Informazioni dettagliate sull'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Dettagli del messaggio di errore.
requestId	string	ID correlazione per la richiesta corrente.
time	string	Ora in cui la richiesta di errore non è riuscita.

RoleAssignment

Definizione dell'assegnazione di ruolo.

Nome	Tipo	Descrizione
organization	string	ID dell'organizzazione per questa assegnazione di ruolo.
role	string	ID del ruolo per questa assegnazione di ruolo.

ServicePrincipalUser

Definizione utente dell'entità servizio.

Nome	Tipo	Descrizione
id	string	ID univoco dell'utente.
objectId	string	ID oggetto AAD dell'entità servizio.
roles	RoleAssignment[]	Elenco di assegnazioni di ruolo che specificano le autorizzazioni per accedere all'applicazione.
tenantId	string	ID tenant di AAD dell'entità servizio.
type	string: servicePrincipal	Tipo di utente.