Users - Create

Usługa:

IoT Central

Wersja interfejsu API:

2022-07-31

Tworzenie użytkownika w aplikacji

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
baseDomain	path	True	string	Domena podstawowa dla wszystkich żądań usług usługi Azure IoT Central.
subdomain	path	True	string	Poddomena aplikacji.
userId	path	True	string	Unikatowy identyfikator użytkownika. Wzorzec wyrażenia regularnego: ^[a-zA-Z0-9-_]*$
api-version	query	True	string	Wywoływana wersja interfejsu API.

Treść żądania

Treść żądania może być jedną z następujących:

Nazwa	Opis
ADGroupUser	Definicja użytkownika grupy usługi Active Directory.
EmailUser	Definicja użytkownika wiadomości e-mail.
ServicePrincipalUser	Definicja użytkownika jednostki usługi.

ADGroupUser

Definicja użytkownika grupy usługi Active Directory.

Nazwa	Wymagane	Typ	Opis
objectId	True	string	Identyfikator obiektu usługi AAD grupy usługi AD.
roles	True	RoleAssignment[]	Lista przypisań ról określających uprawnienia dostępu do aplikacji.
tenantId	True	string	Identyfikator dzierżawy usługi AAD grupy usługi AD.
type	True	string: adGroup	Typ użytkownika.

EmailUser

Definicja użytkownika wiadomości e-mail.

Nazwa	Wymagane	Typ	Opis
email	True	string	Adres e-mail użytkownika.
roles	True	RoleAssignment[]	Lista przypisań ról określających uprawnienia dostępu do aplikacji.
type	True	string: email	Typ użytkownika.

ServicePrincipalUser

Definicja użytkownika jednostki usługi.

Nazwa	Wymagane	Typ	Opis
objectId	True	string	Identyfikator obiektu usługi AAD jednostki usługi.
roles	True	RoleAssignment[]	Lista przypisań ról określających uprawnienia dostępu do aplikacji.
tenantId	True	string	Identyfikator dzierżawy usługi AAD jednostki usługi.
type	True	string: servicePrincipal	Typ użytkownika.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	User: ADGroupUser EmailUser ServicePrincipalUser	Powodzenie
Other Status Codes	Error	Odpowiedź o błędzie odebrana z usługi IoT Central. Nagłówki x-ms-error-code: string

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Add or update a service principal user

Add or update an email user

Add or update a service principal user

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

200

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

Definicje

Nazwa	Opis
ADGroupUser	Definicja użytkownika grupy usługi Active Directory.
EmailUser	Definicja użytkownika wiadomości e-mail.
Error	Definicja błędu odpowiedzi.
ErrorDetails	Szczegółowe informacje o błędzie.
RoleAssignment	Definicja przypisania roli.
ServicePrincipalUser	Definicja użytkownika jednostki usługi.

ADGroupUser

Definicja użytkownika grupy usługi Active Directory.

Nazwa	Typ	Opis
id	string	Unikatowy identyfikator użytkownika.
objectId	string	Identyfikator obiektu usługi AAD grupy usługi AD.
roles	RoleAssignment[]	Lista przypisań ról określających uprawnienia dostępu do aplikacji.
tenantId	string	Identyfikator dzierżawy usługi AAD grupy usługi AD.
type	string: adGroup	Typ użytkownika.

EmailUser

Definicja użytkownika wiadomości e-mail.

Nazwa	Typ	Opis
email	string	Adres e-mail użytkownika.
id	string	Unikatowy identyfikator użytkownika.
roles	RoleAssignment[]	Lista przypisań ról określających uprawnienia dostępu do aplikacji.
type	string: email	Typ użytkownika.

Error

Definicja błędu odpowiedzi.

Nazwa	Typ	Opis
error	ErrorDetails	Szczegóły błędu dla bieżącego żądania.

ErrorDetails

Szczegółowe informacje o błędzie.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Szczegóły komunikatu o błędzie.
requestId	string	Identyfikator korelacji dla bieżącego żądania.
time	string	Czas niepowodzenia żądania błędu.

RoleAssignment

Definicja przypisania roli.

Nazwa	Typ	Opis
organization	string	Identyfikator organizacji dla tego przypisania roli.
role	string	Identyfikator roli dla tego przypisania roli.

ServicePrincipalUser

Definicja użytkownika jednostki usługi.

Nazwa	Typ	Opis
id	string	Unikatowy identyfikator użytkownika.
objectId	string	Identyfikator obiektu usługi AAD jednostki usługi.
roles	RoleAssignment[]	Lista przypisań ról określających uprawnienia dostępu do aplikacji.
tenantId	string	Identyfikator dzierżawy usługi AAD jednostki usługi.
type	string: servicePrincipal	Typ użytkownika.