次の方法で共有

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

ユーザーの一意の ID。

正規表現パターン: ^[a-zA-Z0-9-_]*$
api-version
 query True

string

呼び出される API のバージョン。

要求本文

要求本文は、次のいずれかの可能性があります。

名前 説明
ADGroupUser

Active Directory グループのユーザー定義。
EmailUser

電子メール ユーザー定義。
ServicePrincipalUser

サービス プリンシパルのユーザー定義。

ADGroupUser

Active Directory グループのユーザー定義。

名前 必須 型 説明
objectId True

string

AD グループの AAD オブジェクト ID。
roles True

RoleAssignment[]

アプリケーションにアクセスするためのアクセス許可を指定するロールの割り当ての一覧。
tenantId True

string

AD グループの AAD テナント ID。
type True string:

adGroup

ユーザーの種類。

EmailUser

電子メール ユーザー定義。

名前 必須 型 説明
email True

string

ユーザーの電子メール アドレス。
roles True

RoleAssignment[]

アプリケーションにアクセスするためのアクセス許可を指定するロールの割り当ての一覧。
type True string:

email

ユーザーの種類。

ServicePrincipalUser

サービス プリンシパルのユーザー定義。

名前 必須 型 説明
objectId True

string

サービス プリンシパルの AAD オブジェクト ID。
roles True

RoleAssignment[]

アプリケーションにアクセスするためのアクセス許可を指定するロールの割り当ての一覧。
tenantId True

string

サービス プリンシパルの AAD テナント ID。
type True string:

servicePrincipal

ユーザーの種類。

応答

名前 型 説明
200 OK User:

Success
Other Status Codes

Error

IoT Central サービスから受信したエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 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

要求のサンプル

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

要求のサンプル

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

Active Directory グループのユーザー定義。

名前 型 説明
id

string

ユーザーの一意の ID。
objectId

string

AD グループの AAD オブジェクト ID。
roles

RoleAssignment[]

アプリケーションにアクセスするためのアクセス許可を指定するロールの割り当ての一覧。
tenantId

string

AD グループの AAD テナント ID。
type string:

adGroup

ユーザーの種類。

EmailUser

電子メール ユーザー定義。

名前 型 説明
email

string

ユーザーの電子メール アドレス。
id

string

ユーザーの一意の ID。
roles

RoleAssignment[]

アプリケーションにアクセスするためのアクセス許可を指定するロールの割り当ての一覧。
type string:

email

ユーザーの種類。

Error

応答エラーの定義。

名前 型 説明
error

ErrorDetails

現在の要求のエラーの詳細。

ErrorDetails

エラーの詳細情報。

名前 型 説明
code

string

エラー コード。
message

string

エラー メッセージの詳細。
requestId

string

現在の要求の関連付け ID。
time

string

エラー要求が失敗した時刻。

RoleAssignment

ロールの割り当ての定義。

名前 型 説明
organization

string

このロールの割り当てのorganizationの ID。
role

string

このロールの割り当てのロールの ID。

ServicePrincipalUser

サービス プリンシパルのユーザー定義。

名前 型 説明
id

string

ユーザーの一意の ID。
objectId

string

サービス プリンシパルの AAD オブジェクト ID。
roles

RoleAssignment[]

アプリケーションにアクセスするためのアクセス許可を指定するロールの割り当ての一覧。
tenantId

string

サービス プリンシパルの AAD テナント ID。
type string:

servicePrincipal

ユーザーの種類。