Users - Create

服務:

IoT Central

API 版本:

2022-07-31

在應用程式中建立使用者

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

URI 參數

名稱	位於	必要	類型	Description
baseDomain	path	True	string	所有 Azure IoT Central 服務要求的基底網域。
subdomain	path	True	string	應用程式子域。
userId	path	True	string	使用者的唯一標識碼。 Regex 模式: ^[a-zA-Z0-9-_]*$
api-version	query	True	string	所呼叫之 API 的版本。

要求本文

要求主體可以是下列其中一項：

名稱	Description
ADGroupUser	Active Directory 群組用戶定義。
EmailUser	電子郵件用戶定義。
ServicePrincipalUser	服務主體用戶定義。

ADGroupUser

Active Directory 群組用戶定義。

名稱	必要	類型	Description
objectId	True	string	AD 群組的 AAD 物件識別碼。
roles	True	RoleAssignment[]	指定存取應用程式許可權的角色指派清單。
tenantId	True	string	AD 群組的 AAD 租用戶標識碼。
type	True	string: adGroup	使用者的型別。

EmailUser

電子郵件用戶定義。

名稱	必要	類型	Description
email	True	string	使用者的電子郵件地址。
roles	True	RoleAssignment[]	指定存取應用程式許可權的角色指派清單。
type	True	string: email	使用者的型別。

ServicePrincipalUser

服務主體用戶定義。

名稱	必要	類型	Description
objectId	True	string	服務主體的 AAD 物件識別碼。
roles	True	RoleAssignment[]	指定存取應用程式許可權的角色指派清單。
tenantId	True	string	服務主體的 AAD 租使用者識別碼。
type	True	string: servicePrincipal	使用者的型別。

回應

名稱	類型	Description
200 OK	User: ADGroupUser EmailUser ServicePrincipalUser	Success
Other Status Codes	Error	從 IoT Central 服務收到的錯誤回應。 標題 x-ms-error-code: string

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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"
}

定義

名稱	Description
ADGroupUser	Active Directory 群組用戶定義。
EmailUser	電子郵件用戶定義。
Error	回應錯誤定義。
ErrorDetails	錯誤的詳細資訊。
RoleAssignment	角色指派定義。
ServicePrincipalUser	服務主體用戶定義。

ADGroupUser

Active Directory 群組用戶定義。

名稱	類型	Description
id	string	使用者的唯一標識碼。
objectId	string	AD 群組的 AAD 物件識別碼。
roles	RoleAssignment[]	指定存取應用程式許可權的角色指派清單。
tenantId	string	AD 群組的 AAD 租用戶標識碼。
type	string: adGroup	使用者的型別。

EmailUser

電子郵件用戶定義。

名稱	類型	Description
email	string	使用者的電子郵件地址。
id	string	使用者的唯一標識碼。
roles	RoleAssignment[]	指定存取應用程式許可權的角色指派清單。
type	string: email	使用者的型別。

Error

回應錯誤定義。

名稱	類型	Description
error	ErrorDetails	目前要求的錯誤詳細數據。

ErrorDetails

錯誤的詳細資訊。

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤訊息詳細數據。
requestId	string	目前要求的相互關聯標識碼。
time	string	錯誤要求失敗的時間。

RoleAssignment

角色指派定義。

名稱	類型	Description
organization	string	此角色指派的組織標識碼。
role	string	此角色指派的角色標識碼。

ServicePrincipalUser

服務主體用戶定義。

名稱	類型	Description
id	string	使用者的唯一標識碼。
objectId	string	服務主體的 AAD 物件識別碼。
roles	RoleAssignment[]	指定存取應用程式許可權的角色指派清單。
tenantId	string	服務主體的 AAD 租使用者識別碼。
type	string: servicePrincipal	使用者的型別。