Users - Create

Service:

IoT Central

API Version:

2022-07-31

Erstellen eines Benutzers in der Anwendung

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
baseDomain	path	True	string	Die Basisdomäne für alle Azure IoT Central-Dienstanforderungen.
subdomain	path	True	string	Die Anwendungsunterdomäne.
userId	path	True	string	Eindeutige ID für den Benutzer. Regex pattern: ^[a-zA-Z0-9-_]*$
api-version	query	True	string	Die Version der aufgerufenen API.

Anforderungstext

Beim Anforderungstext kann es sich um eines der folgenden Elemente handeln:

Name	Beschreibung
ADGroupUser	Die Active Directory-Gruppenbenutzerdefinition.
EmailUser	Die E-Mail-Benutzerdefinition.
ServicePrincipalUser	Die Benutzerdefinition des Dienstprinzipals.

ADGroupUser

Die Active Directory-Gruppenbenutzerdefinition.

Name	Erforderlich	Typ	Beschreibung
objectId	True	string	Die AAD-Objekt-ID der AD-Gruppe.
roles	True	RoleAssignment[]	Liste der Rollenzuweisungen, die die Berechtigungen für den Zugriff auf die Anwendung angeben.
tenantId	True	string	Die AAD-Mandanten-ID der AD-Gruppe.
type	True	string: adGroup	Typ des Benutzers.

EmailUser

Die E-Mail-Benutzerdefinition.

Name	Erforderlich	Typ	Beschreibung
email	True	string	E-Mail-Adresse des Benutzers
roles	True	RoleAssignment[]	Liste der Rollenzuweisungen, die die Berechtigungen für den Zugriff auf die Anwendung angeben.
type	True	string: email	Typ des Benutzers.

ServicePrincipalUser

Die Benutzerdefinition des Dienstprinzipals.

Name	Erforderlich	Typ	Beschreibung
objectId	True	string	Die AAD-Objekt-ID des Dienstprinzipals.
roles	True	RoleAssignment[]	Liste der Rollenzuweisungen, die die Berechtigungen für den Zugriff auf die Anwendung angeben.
tenantId	True	string	Die AAD-Mandanten-ID des Dienstprinzipals.
type	True	string: servicePrincipal	Typ des Benutzers.

Antworten

Name	Typ	Beschreibung
200 OK	User: ADGroupUser EmailUser ServicePrincipalUser	Erfolg
Other Status Codes	Error	Eine Vom IoT Central Service empfangene Fehlerantwort. Headers x-ms-error-code: string

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name	Beschreibung
ADGroupUser	Die Active Directory-Gruppenbenutzerdefinition.
EmailUser	Die E-Mail-Benutzerdefinition.
Error	Die Antwortfehlerdefinition.
ErrorDetails	Die Detailinformationen des Fehlers.
RoleAssignment	Die Rollenzuweisungsdefinition.
ServicePrincipalUser	Die Benutzerdefinition des Dienstprinzipals.

ADGroupUser

Die Active Directory-Gruppenbenutzerdefinition.

Name	Typ	Beschreibung
id	string	Eindeutige ID des Benutzers.
objectId	string	Die AAD-Objekt-ID der AD-Gruppe.
roles	RoleAssignment[]	Liste der Rollenzuweisungen, die die Berechtigungen für den Zugriff auf die Anwendung angeben.
tenantId	string	Die AAD-Mandanten-ID der AD-Gruppe.
type	string: adGroup	Typ des Benutzers.

EmailUser

Die E-Mail-Benutzerdefinition.

Name	Typ	Beschreibung
email	string	E-Mail-Adresse des Benutzers
id	string	Eindeutige ID des Benutzers.
roles	RoleAssignment[]	Liste der Rollenzuweisungen, die die Berechtigungen für den Zugriff auf die Anwendung angeben.
type	string: email	Typ des Benutzers.

Error

Die Antwortfehlerdefinition.

Name	Typ	Beschreibung
error	ErrorDetails	Fehlerdetails für die aktuelle Anforderung.

ErrorDetails

Die Detailinformationen des Fehlers.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Fehlermeldungsdetails.
requestId	string	Korrelations-ID für die aktuelle Anforderung.
time	string	Der Zeitpunkt, zu dem die Fehleranforderung fehlgeschlagen ist.

RoleAssignment

Die Rollenzuweisungsdefinition.

Name	Typ	Beschreibung
organization	string	ID des organization für diese Rollenzuweisung.
role	string	ID der Rolle für diese Rollenzuweisung.

ServicePrincipalUser

Die Benutzerdefinition des Dienstprinzipals.

Name	Typ	Beschreibung
id	string	Eindeutige ID des Benutzers.
objectId	string	Die AAD-Objekt-ID des Dienstprinzipals.
roles	RoleAssignment[]	Liste der Rollenzuweisungen, die die Berechtigungen für den Zugriff auf die Anwendung angeben.
tenantId	string	Die AAD-Mandanten-ID des Dienstprinzipals.
type	string: servicePrincipal	Typ des Benutzers.