Users - Create

Služba:

IoT Central

Verze rozhraní API:

2022-07-31

Vytvoření uživatele v aplikaci

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
baseDomain	path	True	string	Základní doména pro všechny žádosti o službu Azure IoT Central
subdomain	path	True	string	Subdoména aplikace.
userId	path	True	string	Jedinečné ID uživatele. Vzor regulárního výrazu: ^[a-zA-Z0-9-_]*$
api-version	query	True	string	Verze rozhraní API, která se volá.

Text požadavku

Text žádosti může tvořit:

Name	Description
ADGroupUser	Definice uživatele skupiny active directory.
EmailUser	Definice uživatele e-mailu
ServicePrincipalUser	Definice uživatele instančního objektu.

ADGroupUser

Definice uživatele skupiny active directory.

Name	Vyžadováno	Typ	Description
objectId	True	string	ID objektu AAD skupiny AD.
roles	True	RoleAssignment[]	Seznam přiřazení rolí, která určují oprávnění pro přístup k aplikaci.
tenantId	True	string	ID tenanta AAD skupiny AD.
type	True	string: adGroup	Typ uživatele.

EmailUser

Definice uživatele e-mailu

Name	Vyžadováno	Typ	Description
email	True	string	E-mailová adresa uživatele
roles	True	RoleAssignment[]	Seznam přiřazení rolí, která určují oprávnění pro přístup k aplikaci.
type	True	string: email	Typ uživatele.

ServicePrincipalUser

Definice uživatele instančního objektu.

Name	Vyžadováno	Typ	Description
objectId	True	string	ID objektu AAD instančního objektu.
roles	True	RoleAssignment[]	Seznam přiřazení rolí, která určují oprávnění pro přístup k aplikaci.
tenantId	True	string	ID tenanta AAD instančního objektu.
type	True	string: servicePrincipal	Typ uživatele.

Odpovědi

Name	Typ	Description
200 OK	User: ADGroupUser EmailUser ServicePrincipalUser	Success
Other Status Codes	Error	Ze služby IoT Central byla přijata chybová odpověď. Hlavičky x-ms-error-code: string

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Add or update a service principal user

Add or update an email user

Add or update a service principal user

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
ADGroupUser	Definice uživatele skupiny active directory.
EmailUser	Definice uživatele e-mailu
Error	Definice chyby odpovědi.
ErrorDetails	Podrobné informace o chybě
RoleAssignment	Definice přiřazení role.
ServicePrincipalUser	Definice uživatele instančního objektu.

ADGroupUser

Definice uživatele skupiny active directory.

Name	Typ	Description
id	string	Jedinečné ID uživatele.
objectId	string	ID objektu AAD skupiny AD.
roles	RoleAssignment[]	Seznam přiřazení rolí, která určují oprávnění pro přístup k aplikaci.
tenantId	string	ID tenanta AAD skupiny AD.
type	string: adGroup	Typ uživatele.

EmailUser

Definice uživatele e-mailu

Name	Typ	Description
email	string	E-mailová adresa uživatele
id	string	Jedinečné ID uživatele.
roles	RoleAssignment[]	Seznam přiřazení rolí, která určují oprávnění pro přístup k aplikaci.
type	string: email	Typ uživatele.

Error

Definice chyby odpovědi.

Name	Typ	Description
error	ErrorDetails	Podrobnosti o chybě pro aktuální požadavek

ErrorDetails

Podrobné informace o chybě

Name	Typ	Description
code	string	Kód chyby
message	string	Podrobnosti o chybové zprávě
requestId	string	ID korelace pro aktuální požadavek
time	string	Čas, kdy žádost o chybu selhala.

RoleAssignment

Definice přiřazení role.

Name	Typ	Description
organization	string	ID organizace pro toto přiřazení role.
role	string	ID role pro toto přiřazení role

ServicePrincipalUser

Definice uživatele instančního objektu.

Name	Typ	Description
id	string	Jedinečné ID uživatele.
objectId	string	ID objektu AAD instančního objektu.
roles	RoleAssignment[]	Seznam přiřazení rolí, která určují oprávnění pro přístup k aplikaci.
tenantId	string	ID tenanta AAD instančního objektu.
type	string: servicePrincipal	Typ uživatele.