Users - Create

Служба:: IoT Central

Версия API:: 2022-07-31

Создание пользователя в приложении

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
baseDomain	path	True	string	Базовый домен для всех запросов службы Azure IoT Central.
subdomain	path	True	string	Поддомен приложения.
userId	path	True	string maxLength: 48 pattern: ^[a-zA-Z0-9-_]*$	Уникальный идентификатор пользователя.
api-version	query	True	string	Версия вызываемого API.

Текст запроса

Текст запроса может быть таким:

Имя	Описание
ADGroupUser	Определение пользователя группы Active Directory.
EmailUser	Определение пользователя электронной почты.
ServicePrincipalUser	Определение пользователя субъекта-службы.

ADGroupUser

Определение пользователя группы Active Directory.

Имя	Обязательно	Тип	Описание
objectId	True	string	Идентификатор объекта AAD группы AD.
roles	True	RoleAssignment[]	Список назначений ролей, указывающих разрешения для доступа к приложению.
tenantId	True	string	Идентификатор клиента AAD группы AD.
type	True	string: adGroup	Тип пользователя.

EmailUser

Определение пользователя электронной почты.

Имя	Обязательно	Тип	Описание
email	True	string	Адрес электронной почты пользователя.
roles	True	RoleAssignment[]	Список назначений ролей, указывающих разрешения для доступа к приложению.
type	True	string: email	Тип пользователя.

ServicePrincipalUser

Определение пользователя субъекта-службы.

Имя	Обязательно	Тип	Описание
objectId	True	string	Идентификатор объекта AAD субъекта-службы.
roles	True	RoleAssignment[]	Список назначений ролей, указывающих разрешения для доступа к приложению.
tenantId	True	string	Идентификатор клиента AAD субъекта-службы.
type	True	string: servicePrincipal	Тип пользователя.

Ответы

Имя	Тип	Описание
200 OK	User: ADGroupUser EmailUser ServicePrincipalUser	Успех
Other Status Codes	Error	Ответ об ошибке, полученный от службы IoT Central. Заголовки x-ms-error-code: string

Имя

Тип

Описание

200 OK

User:

ADGroupUser
EmailUser
ServicePrincipalUser

Успех

Other Status Codes

Error

Ответ об ошибке, полученный от службы IoT Central.

Заголовки

x-ms-error-code: string

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Add or update a service principal user

Add or update an email user

Add or update a service principal user

Образец запроса

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

Пример ответа

Код состояния:: 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

Образец запроса

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

Пример ответа

Код состояния:: 200

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

Определения

Имя	Описание
ADGroupUser	Определение пользователя группы Active Directory.
EmailUser	Определение пользователя электронной почты.
Error	Определение ошибки ответа.
ErrorDetails	Подробные сведения об ошибке.
RoleAssignment	Определение назначения ролей.
ServicePrincipalUser	Определение пользователя субъекта-службы.

ADGroupUser

Object

Определение пользователя группы Active Directory.

Имя	Тип	Описание
id	string	Уникальный ИД пользователя.
objectId	string	Идентификатор объекта AAD группы AD.
roles	RoleAssignment[]	Список назначений ролей, указывающих разрешения для доступа к приложению.
tenantId	string	Идентификатор клиента AAD группы AD.
type	string: adGroup	Тип пользователя.

EmailUser

Object

Определение пользователя электронной почты.

Имя	Тип	Описание
email	string	Адрес электронной почты пользователя.
id	string	Уникальный ИД пользователя.
roles	RoleAssignment[]	Список назначений ролей, указывающих разрешения для доступа к приложению.
type	string: email	Тип пользователя.

Error

Object

Определение ошибки ответа.

Имя	Тип	Описание
error	ErrorDetails	Сведения об ошибке для текущего запроса.

ErrorDetails

Object

Подробные сведения об ошибке.

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сведения об сообщении об ошибке.
requestId	string	Идентификатор корреляции для текущего запроса.
time	string (date-time-rfc1123)	Время сбоя запроса на ошибку.

RoleAssignment

Object

Определение назначения ролей.

Имя	Тип	Описание
organization	string	Идентификатор организации для назначения ролей.
role	string	Идентификатор роли для назначения этой роли.

ServicePrincipalUser

Object

Определение пользователя субъекта-службы.

Имя	Тип	Описание
id	string	Уникальный ИД пользователя.
objectId	string	Идентификатор объекта AAD субъекта-службы.
roles	RoleAssignment[]	Список назначений ролей, указывающих разрешения для доступа к приложению.
tenantId	string	Идентификатор клиента AAD субъекта-службы.
type	string: servicePrincipal	Тип пользователя.