N-able Cloud User Hub (プレビュー)
クラウド ユーザー ハブは、統合された Microsoft CSP ポータルであり、コンソールや顧客を切り替えることなくすべての Microsoft 365 アプリで共通のタスクを自動化できます。
このコネクタは、次の製品および地域で利用可能です:
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | Cloud User Hub サポート |
| [URL] | https://documentation.clouduserhub.management/kb/en |
| メール | technicalsupport@n-able.com |
| Connector Metadata | |
|---|---|
| 発行者 | N-able Cloud User Hub B.V. |
| Web サイト | https://www.n-able.com |
| プライバシー ポリシー | https://www.n-able.com/legal/privacy |
| カテゴリー | 事業部管理; IT 操作 |
クラウド ユーザー ハブは、統合された Microsoft CSP ポータルであり、コンソールや顧客を切り替えることなくすべての Microsoft 365 アプリで共通のタスクを自動化できます。
前提条件
続行するには、次のものが必要です。
- Cloud User Hub のサブスクリプション
- 使用する特定操作のために Cloud User Hub で構成されたソリューション
- 使用する特定操作のために Cloud User Hub で構成された役割。
資格情報の入手方法
Cloud User Hub にアクセスするように構成されている任意のアカウントでログインできます。 自動化シナリオでは、専用のサービス アカウントを使用することをお勧めします。
コネクタの使用を開始する
[組織の取得] から始めて、管理が許可されている組織 (自分の組織を含む) のリストを取得します。 組織は、Cloud User Hub で構成されたロール スコープに従って返されます。 連続した通話には ID を使用します。 パートナー ID が必要な操作の場合は、自分の組織の ID を使用してください。 一部の操作では、内部 Cloud User Hub ID の代わりにテナント ID、または両方が必要になります。
既知の問題と制限事項
一部の操作では、対象の組織が一致する Microsoft 365 ライセンスまたはアクティブな Azure サブスクリプションを持っている必要があります。 例: 条件付きアクセスの構成には、Microsoft Entra ID プレミアム ライセンスが必要です。
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| Azure AD グループを作成する |
Azure AD グループを作成します。 |
| Azure AD セキュリティ グループの取得 |
表示を許可されているすべての組織の Azure AD セキュリティグループのリストを取得します。 |
| Cloud User Hub のユーザ グループ メンバーのリストを取得する |
特定のグループのユーザー グループ メンバーのリストを取得します。 |
| Cloud User Hub のユーザー グループの削除 |
ユーザー グループを削除します。 |
| Cloud User Hub のユーザー グループを取得する |
表示を許可されているすべての組織の セキュリティ グループのリストを取得します。 |
| Get locales |
ロケールを取得します。 |
| Get user license details |
エンタープライズ ユーザーのライセンス詳細オブジェクトのリストを取得します。 |
| List organization domains |
ドメイン オブジェクトの一覧を取得します。 |
| Remove a member from a user group |
ユーザー グループからメンバーを削除します。 |
| Update subscription quantity |
サブスクリプションの数量を更新します。 |
| User change password |
ユーザーのパスワード プロファイルを更新して、パスワードをリセットします。 |
| グループにメンバーを追加する |
メンバー ナビゲーション プロパティを使用して、Microsoft 365 グループまたはセキュリティ グループにメンバーを追加します。 |
| グループのコマンド ブロック ジョブを追加する |
コマンド ブロック ジョブを追加します。 プロバイダーとアクションの検証は、特定のコマンド ブロックに基づいています。 |
| コマンド カテゴリを取得する |
利用可能なすべてのカテゴリとサブカテゴリを取得します。 |
| コマンド ブロックの詳細を取得 |
コマンド ブロックの詳細を取得します。 特定のコマンド ブロックによって検証を提供してアクションをおこします。 |
| コマンドブロック リスト |
利用可能なコマンド ブロックのリストを取得します。 |
| メンバーの削除 |
メンバー ナビゲーション プロパティを使用して、グループからメンバーを削除します。 |
| ユーザー グループにメンバーを追加する |
メンバーをユーザー グループに追加します。メンバーはグループと同じ組織に属している必要があります。 |
| ユーザーにコマンド ブロック ジョブを追加する |
コマンド ブロック ジョブを追加します。 プロバイダーとアクションの検証は、特定のコマンド ブロックに基づいています。 |
| ユーザーにライセンスを割り当てる |
ユーザーのライセンスを追加または削除します。 ライセンスに関連付けられている特定のプランを有効または無効にすることもできます。 |
| ユーザーの詳細を取得する |
Microsoft オブジェクト ID でユーザーを取得します。 |
| ユーザーを作成 |
要求本文には、作成するユーザーが含まれています。 少なくとも、ユーザーに必要なプロパティを指定する必要があります。 オプションで、他の書き込み可能なプロパティを指定できます。 |
| ユーザーを削除 |
ユーザーを削除します。 削除すると、ユーザー リソースは一時コンテナに移動され、30 日以内に復元できます。 その後、それらは完全に削除されます。 |
| ユーザーを取得する |
ユーザー オブジェクトの一覧を取得します。 |
| 単一ユーザージョブの詳細を取得する |
単一ユーザー ジョブの詳細を取得して、特定のコマンド ブロックによる検証をアクションする。 |
| 承認されたすべての組織のコマンド ブロック ジョブの統計を取得 |
表示権限のあるコマンド ブロックのコマンド ブロック ジョブで統計を取得します。 |
| 承認されたすべての組織のコマンド ブロック ジョブを取得する |
表示権限のあるコマンド ブロックのコマンド ブロック ジョブを取得します。 |
| 特定の組織のコマンド ブロック ジョブを取得する |
表示権限のあるコマンド ブロックのコマンド ブロック ジョブを取得します。 |
| 組織がサブスクライブした SKU を取得する |
組織が取得した商用サブスクリプションのリストを取得します。 |
| 組織のコマンド ブロック ジョブを追加する |
コマンド ブロック ジョブを追加します。 プロバイダーとアクションの検証は、特定のコマンド ブロックに基づいています。 |
| 複数の組織を取得する |
表示を許可されているすべての組織を取得します。 |
| 購読を取得する |
パートナーの顧客のすべてのサブスクリプションを、Active Directory テナント ID によって取得します。 |
Azure AD グループを作成する
Azure AD グループを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Cloud User Hub 組織 ID。
|
organizationId | True | string |
Cloud User Hub 組織の識別し。 |
|
説明設定
|
description | string |
グループの説明。 |
|
|
表示名称
|
displayName | string |
グループの表示名。 |
|
|
groupTypes
|
groupTypes | array of string |
グループの種類。 |
|
|
Mail enabled
|
mailEnabled | boolean |
グループのメールが有効化されているかどうかを示します。 |
|
|
Mail nickname
|
mailNickname | string |
グループのメール ニックネーム。 |
|
|
Security enabled
|
securityEnabled | boolean |
グループのセキュリティが有効化されているかどうかを示します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Id
|
id | string |
グループの ID。 |
|
Deleted on
|
deletedDateTime | string |
削除した日時。 |
|
Classification
|
classification | string |
グループの分類。 |
|
Created on
|
createdDateTime | string |
作成日。 |
|
creationOptions
|
creationOptions | array of string |
作成オプション。 |
|
Description
|
description | string |
説明。 |
|
Display name
|
displayName | string |
表示名。 |
|
groupTypes
|
groupTypes | array of string |
groupTypes |
|
メール
|
string |
グループのメール アドレスです。 |
|
|
Mail enabled
|
mailEnabled | boolean |
グループのメールが有効化されていることを示します。 |
|
Mail nickname
|
mailNickname | string |
グループのメール ニックネーム。 |
|
On premise last sync
|
onPremisesLastSyncDateTime | string |
グループがオンプレミスでいつ同期されたかを示します。 |
|
On premise security identifier
|
onPremisesSecurityIdentifier | string |
グループのオンプレミス セキュリティ ID。 |
|
On premise sync enabled
|
onPremisesSyncEnabled | string |
オンプレミス同期が有効になっていることを示します。 |
|
Preferred data location
|
preferredDataLocation | string |
グループの優先データの場所。 |
|
proxyAddresses
|
proxyAddresses | array of string |
プロキシ アドレス。 |
|
Renewed
|
renewedDateTime | string |
グループの更新日時。 |
|
resourceBehaviorOptions
|
resourceBehaviorOptions | array of string |
リソース動向のオプション。 |
|
resourceProvisioningOptions
|
resourceProvisioningOptions | array of string |
リソースのプロビジョニング オプション。 |
|
Security enabled
|
securityEnabled | boolean |
グループのセキュリティが有効化されているかどうかを示します。 |
|
Visbility
|
visibility | string |
グループの可視性。 |
|
onPremisesProvisioningErrors
|
onPremisesProvisioningErrors | array of string |
オンプレミスのプロビジョニング エラー。 |
Azure AD セキュリティ グループの取得
表示を許可されているすべての組織の Azure AD セキュリティグループのリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Cloud User Hub 組織 ID。
|
organizationId | True | string |
Cloud User Hub 組織の識別し。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
価値
|
value | array of object |
値。 |
|
Created on
|
value.createdDateTime | string |
作成日。 |
|
Displayname
|
value.displayName | string |
表示名。 |
|
groupTypes
|
value.groupTypes | array of string |
グループの種類。 |
|
Id
|
value.id | string |
グループの Microsoft オブジェクト ID。 |
|
Security enabled
|
value.securityEnabled | boolean |
グループのセキュリティが有効化されているかどうかを示します。 |
|
メール
|
value.mail | string |
グループのメール アドレスです。 |
Cloud User Hub のユーザ グループ メンバーのリストを取得する
特定のグループのユーザー グループ メンバーのリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Cloud User Hub 組織 ID。
|
organizationId | True | string |
Cloud User Hub 組織の識別し。 |
|
グループの Cloud User Hub 識別子。
|
userGroupId | True | string |
グループの Cloud User Hub 識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
@odata.count | integer |
OData カウント。 |
|
価値
|
value | array of object |
値。 |
|
件名
|
value.name | string |
名前。 |
|
User principal name
|
value.upn | string |
グループのユーザー プリンシパル名。 |
|
Id
|
value.id | string |
グループ メンバー オブジェクトの ID。 |
|
Group id
|
value.groupId | string |
グループの Cloud User Hub 識別子。 |
|
Created on
|
value.createdOn | string |
作成日。 |
|
Modified on
|
value.modifiedOn | string |
作成日時。 |
Cloud User Hub のユーザー グループの削除
ユーザー グループを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Cloud User Hub 組織 ID。
|
organizationId | True | string |
Cloud User Hub 組織の識別し。 |
|
ユーザー グループの Cloud User Hub 識別子。
|
userGroupId | True | string |
ユーザー グループの Cloud User Hub 識別子。 |
Cloud User Hub のユーザー グループを取得する
表示を許可されているすべての組織の セキュリティ グループのリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
グループのフィルター。
|
$filter | True | string |
組織内のグループをフィルタリングします。 用途: ('{organizationId}') の組織 ID。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
@odata.count | integer |
OData カウント。 |
|
価値
|
value | array of object |
値。 |
|
組織 ID
|
value.organizationId | string |
Cloud User Hub 組織の識別し。 |
|
件名
|
value.name | string |
グループの名前。 |
|
説明設定
|
value.description | string |
グループの説明。 |
|
Id
|
value.id | string |
グループの ID。 |
|
Created on
|
value.createdOn | string |
作成日。 |
|
Modified on
|
value.modifiedOn | string |
更新日時。 |
Get locales
ロケールを取得します。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
OData コンテキスト
|
@odata.context | string |
OData コンテキスト。 |
|
数
|
@odata.count | integer |
OData カウント。 |
|
OData nextLink
|
@odata.nextLink | string |
OData nextlink. |
|
価値
|
value | array of object |
値。 |
|
Id
|
value.id | string |
ロケール ID。 |
|
ロケール コード
|
value.localeCode | string |
ISO-639 言語コード。 |
|
国コード
|
value.countryCode | string |
ISO-3166 国コード。 |
|
国名
|
value.countryName | string |
国名。 |
Get user license details
エンタープライズ ユーザーのライセンス詳細オブジェクトのリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Cloud User Hub 組織 ID。
|
organizationId | True | string |
Cloud User Hub 組織の識別し。 |
|
Microsoft object id of the user.
|
microsoftObjectId | True | string |
ユーザーの Microsoft オブジェクト ID。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
価値
|
value | array of object |
値。 |
|
Id
|
value.id | string |
ユーザーのライセンスの ID。 |
|
Sku id
|
value.skuId | string |
Microsoft ライセンスの Sku ID。 |
|
Sku partnumber
|
value.skuPartNumber | string |
Microsoft ライセンスの Sku の部品番号。 |
|
servicePlans
|
value.servicePlans | array of object |
サービス プラン。 |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Serviceplan の ID。 |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Serviceplan の名前。 |
|
provisioningStatus
|
value.servicePlans.provisioningStatus | string |
プロビジョニングの状態。 |
|
appliesTo
|
value.servicePlans.appliesTo | string |
適用対象。 |
List organization domains
ドメイン オブジェクトの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Cloud User Hub 組織 ID。
|
organizationId | True | string |
Cloud User Hub 組織の識別し。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
価値
|
value | array of object |
値。 |
|
認証の種類
|
value.authenticationType | string |
ドメインの認証の種類。 |
|
Availability status
|
value.availabilityStatus | string |
ドメインの可用性の状態。 |
|
Id
|
value.id | string |
ドメインの ID。 |
|
Admin managed
|
value.isAdminManaged | boolean |
ドメインが管理者によって管理されているかどうかを示します。 |
|
既定
|
value.isDefault | boolean |
これがデフォルトのドメインであるかどうかを示します。 |
|
初期
|
value.isInitial | boolean |
これが最初のドメインであるかどうかを示します。 |
|
ルート
|
value.isRoot | boolean |
ルート ドメインであるかどうかを示します。 |
|
検証済み
|
value.isVerified | boolean |
ドメインが検証されているかどうかを示します。 |
|
supportedServices
|
value.supportedServices | array of string |
サポートされているサービス。 |
|
Password validity
|
value.passwordValidityPeriodInDays | integer |
パスワードの有効期間を日数で示します。 |
|
Password notification windows
|
value.passwordNotificationWindowInDays | integer |
パスワード通知期間を日数で示します。 |
|
状態
|
value.state | string |
ドメインの状態。 |
Remove a member from a user group
ユーザー グループからメンバーを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Cloud User Hub 組織 ID。
|
organizationId | True | string |
Cloud User Hub 組織の識別し。 |
|
Cloud User Hub のユーザー グループ ID。
|
userGroupId | True | string |
Cloud User Hub のユーザー グループ識別子。 |
|
Cloud User Hub のユーザー ID。
|
userId | True | string |
Cloud User Hub のユーザー識別子。 |
Update subscription quantity
サブスクリプションの数量を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Cloud User Hub のパートナー ID。
|
partnerId | True | string |
Cloud User Hub のパートナー ID。 |
|
Cloud User Hub の顧客 ID。
|
customerId | True | string |
Cloud User Hub の顧客 ID。 |
|
顧客の Microsoft テナント ID。
|
tenantId | True | string |
顧客の Microsoft テナント ID。 |
|
Subsription ID。
|
subscriptionId | True | string |
顧客のサブスクリプション ID。 |
|
数量
|
quantity | integer |
サブスクリプションの数量。 |
User change password
ユーザーのパスワード プロファイルを更新して、パスワードをリセットします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Cloud User Hub 組織 ID。
|
organizationId | True | string |
Cloud User Hub 組織の識別し。 |
|
Microsoft object id of the user.
|
microsoftObjectId | True | string |
ユーザーの Microsoft オブジェクト ID。 |
|
Force password change at signin
|
forceChangePasswordNextSignIn | boolean |
ユーザーは次のサインインで一時パスワードを強制的に変更します。 |
|
|
Password
|
password | string |
せって尾する新しいパスワード。 |
グループにメンバーを追加する
メンバー ナビゲーション プロパティを使用して、Microsoft 365 グループまたはセキュリティ グループにメンバーを追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Cloud User Hub 組織 ID。
|
organizationId | True | string |
Cloud User Hub 組織の識別し。 |
|
グループの Microsoft オブジェクト ID。
|
microsoftObjectId | True | string |
グループの Microsoft オブジェクト ID。 |
|
メンバー
|
@odata.id | True | string |
追加するディレクトリ、ユーザー、グループ、または組織の連絡先オブジェクトの URI。 |
グループのコマンド ブロック ジョブを追加する
コマンド ブロック ジョブを追加します。 プロバイダーとアクションの検証は、特定のコマンド ブロックに基づいています。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
組織 ID
|
organizationId | True | string |
形式 - uuid。 組織を表す一意識別子です。 |
|
コマンド ブロック ID
|
commandBlockId | True | string |
形式 - uuid。 コマンド ブロックの一意識別子。 |
|
ターゲット グループ ID
|
targetGroupId | True | string |
形式 - uuid。 ターゲット グループの一意の識別子。 |
|
テクニカル ID
|
technicalIdentifier | string |
技術的な識別子。 |
|
|
価値
|
value | string |
値。 |
|
|
スケジュール ID
|
scheduleId | string |
スケジュールの識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
価値
|
value | string |
値。 |
コマンド カテゴリを取得する
利用可能なすべてのカテゴリとサブカテゴリを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
$top 項目
|
$top | string |
最初のストップ項目のみを返します。 |
|
|
$skip 項目
|
$skip | string |
スキップする項目の数。 |
|
|
フィルターの選択
|
$select | string |
OData フィルターを選択します。 |
|
|
並べ替え順
|
$orderby | string |
レコードのコレクションを並べ替えるために使用される値を決定します。 |
|
|
フィルター
|
$filter | string |
レコードが返されるためにtrueと評価される必要がある関数。 |
|
|
数
|
$count | string |
アイテムの数をコレクションに含めるかどうかを決定します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
OData context
|
@odata.context | string |
OData コンテキスト。 |
|
OData count
|
@odata.count | integer |
OData カウント。 |
|
OData の次のリンク
|
@odata.nextLink | string |
OData の次のリンク。 |
|
価値
|
value | array of object |
値。 |
|
Id
|
value.id | string |
ID。 |
|
テクニカル ID
|
value.technicalIdentifier | string |
技術的な識別子。 |
|
親カテゴリ ID
|
value.parentCategoryId | string |
親カテゴリの識別子。 |
コマンド ブロックの詳細を取得
コマンド ブロックの詳細を取得します。 特定のコマンド ブロックによって検証を提供してアクションをおこします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コマンド ブロック ID
|
commandBlockId | True | string |
形式 - uuid。 コマンド ブロックの一意識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Id
|
id | string |
ID。 |
|
Version
|
version | integer |
バージョン。 |
|
カテゴリ ID
|
categoryId | string |
カテゴリ ID。 |
|
テクニカル ID
|
technicalIdentifier | string |
技術的な識別子。 |
|
必要な読取りアクション
|
requiredReadAction | string |
必要な読取りアクション。 |
|
必要な書き込みアクション
|
requiredWriteAction | string |
必要な書き込みアクション。 |
|
必要なプロバイダー
|
requiredProvider | string |
必要なプロバイダー。 |
|
タイプ
|
type | string |
タイプ。 |
|
Id
|
category.id | string |
ID。 |
|
テクニカル ID
|
category.technicalIdentifier | string |
技術的な識別子。 |
|
Id
|
parentCategory.id | string |
ID。 |
|
テクニカル ID
|
parentCategory.technicalIdentifier | string |
技術的な識別子。 |
|
Id
|
menuCategory.id | string |
ID。 |
|
テクニカル ID
|
menuCategory.technicalIdentifier | string |
技術的な識別子。 |
|
複数選択
|
commandInput.multiSelection | string |
複数選択。 |
|
layoutGroups
|
commandInput.layoutGroups | array of object |
グループのレイアウト。 |
|
テクニカル ID
|
commandInput.layoutGroups.technicalIdentifier | string |
技術的な識別子。 |
|
layoutGroupFormats
|
commandInput.layoutGroups.layoutGroupFormats | array of object |
レイアウト グループの形式。 |
|
タイプ
|
commandInput.layoutGroups.layoutGroupFormats.type | string |
タイプ。 |
|
property
|
commandInput.layoutGroups.layoutGroupFormats.property | string |
プロパティ。 |
|
properties
|
commandInput.layoutGroups.layoutGroupFormats.properties | array of |
プロパティ。 |
|
parameters
|
commandInput.parameters | array of object |
パラメーター。 |
|
規定値
|
commandInput.parameters.defaultValue | string |
規定値。 |
|
テクニカル ID
|
commandInput.parameters.technicalIdentifier | string |
技術的な識別子。 |
|
Schema
|
commandInput.parameters.schema | string |
スキーマ。 |
|
機密
|
commandInput.parameters.sensitive | boolean |
機密。 |
|
Required
|
commandInput.parameters.required | boolean |
必須。 |
|
価値
|
commandInput.parameters.value | string |
値。 |
|
コマンド セット
|
commandInput.parameters.placeholderEnabled.commandSet | boolean |
コマンド セット。 |
|
コマンド ブロック
|
commandInput.parameters.placeholderEnabled.commandBlock | boolean |
コマンド ブロック。 |
|
linkedCommandBlocks
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks | array of object |
リンクされたコマンドブロック。 |
|
technicalIdentifier
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier | string |
技術的な識別子。 |
|
version
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.version | integer |
バージョン。 |
|
layoutGroups
|
commandOutput.layoutGroups | array of object |
グループのレイアウト。 |
|
テクニカル ID
|
commandOutput.layoutGroups.technicalIdentifier | string |
技術的な識別子。 |
|
layoutGroupFormats
|
commandOutput.layoutGroups.layoutGroupFormats | array of object |
レイアウト グループの形式。 |
|
タイプ
|
commandOutput.layoutGroups.layoutGroupFormats.type | string |
タイプ。 |
|
property
|
commandOutput.layoutGroups.layoutGroupFormats.property | string |
プロパティ。 |
|
properties
|
commandOutput.layoutGroups.layoutGroupFormats.properties | array of |
プロパティ。 |
|
parameters
|
commandOutput.parameters | array of object |
パラメーター。 |
|
例
|
commandOutput.parameters.example | string |
例。 |
|
テクニカル ID
|
commandOutput.parameters.technicalIdentifier | string |
技術的な識別子。 |
|
Schema
|
commandOutput.parameters.schema | string |
スキーマ。 |
|
機密
|
commandOutput.parameters.sensitive | boolean |
機密。 |
|
Required
|
commandOutput.parameters.required | boolean |
必須。 |
|
価値
|
commandOutput.parameters.value | string |
値。 |
|
コマンド セット
|
commandOutput.parameters.placeholderEnabled.commandSet | boolean |
コマンド セット。 |
|
コマンド ブロック
|
commandOutput.parameters.placeholderEnabled.commandBlock | boolean |
コマンド ブロック。 |
コマンドブロック リスト
利用可能なコマンド ブロックのリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
$top 項目
|
$top | string |
最初のストップ項目のみを返します。 |
|
|
$skip 項目
|
$skip | string |
スキップする項目の数。 |
|
|
フィルターの選択
|
$select | string |
OData フィルターを選択します。 |
|
|
並べ替え順
|
$orderby | string |
レコードのコレクションを並べ替えるために使用される値を決定します。 |
|
|
フィルター
|
$filter | string |
レコードが返されるためにtrueと評価される必要がある関数。 |
|
|
数
|
$count | string |
アイテムの数をコレクションに含めないように決定します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
OData context
|
@odata.context | string |
OData コンテキスト。 |
|
OData count
|
@odata.count | integer |
OData カウント。 |
|
OData の次のリンク
|
@odata.nextLink | string |
OData の次のリンク。 |
|
価値
|
value | array of object |
値。 |
|
Id
|
value.id | string |
識別子。 |
|
テクニカル ID
|
value.technicalIdentifier | string |
技術的な識別子。 |
|
タイプ
|
value.type | string |
タイプ。 |
|
Version
|
value.version | integer |
バージョン。 |
|
カテゴリ ID
|
value.categoryId | string |
カテゴリ識別子。 |
|
必要な読取りアクション
|
value.requiredReadAction | string |
必要な読取りアクション。 |
|
必要な書き込みアクション
|
value.requiredWriteAction | string |
必要な書き込みアクション。 |
|
必要なプロバイダー
|
value.requiredProvider | string |
必要なプロバイダー。 |
|
メニュー カテゴリ ID
|
value.menuCategory.id | string |
メニュー カテゴリの識別子。 |
|
テクニカル ID
|
value.menuCategory.technicalIdentifier | string |
技術的な識別子。 |
|
親カテゴリ ID
|
value.parentCategory.id | string |
親カテゴリの識別子。 |
|
テクニカル ID
|
value.parentCategory.technicalIdentifier | string |
技術的な識別子。 |
|
Id
|
value.category.id | string |
カテゴリの ID。 |
|
技術的な識別子
|
value.category.technicalIdentifier | string |
技術的な識別子。 |
メンバーの削除
メンバー ナビゲーション プロパティを使用して、グループからメンバーを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Cloud User Hub 組織 ID。
|
organizationId | True | string |
Cloud User Hub 組織の識別し。 |
|
グループの Microsoft オブジェクト ID。
|
groupMicrosoftObjectId | True | string |
グループの Microsoft オブジェクト ID。 |
|
Microsoft object id of the user.
|
userMicrosoftObjectId | True | string |
ユーザーの Microsoft オブジェクト ID。 |
ユーザー グループにメンバーを追加する
メンバーをユーザー グループに追加します。メンバーはグループと同じ組織に属している必要があります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Cloud User Hub 組織 ID。
|
organizationId | True | string |
Cloud User Hub 組織の識別し。 |
|
Cloud User Hub のユーザー グループ ID。
|
userGroupId | True | string |
Cloud User Hub のユーザー グループ識別子。 |
|
Cloud User Hub のユーザー ID。
|
userId | True | string |
Cloud User Hub のユーザー識別子。 |
ユーザーにコマンド ブロック ジョブを追加する
コマンド ブロック ジョブを追加します。 プロバイダーとアクションの検証は、特定のコマンド ブロックに基づいています。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
組織 ID
|
organizationId | True | string |
形式 - uuid。 組織を表す一意識別子です。 |
|
コマンド ブロック ID
|
commandBlockId | True | string |
形式 - uuid。 コマンド ブロックの一意識別子。 |
|
ターゲット ユーザー ID
|
targetUserId | True | string |
形式 - uuid。 ターゲット ユーザーの一意の識別子。 |
|
テクニカル ID
|
technicalIdentifier | string |
技術的な識別子。 |
|
|
価値
|
value | string |
値。 |
|
|
スケジュール ID
|
scheduleId | string |
スケジュールの識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
価値
|
value | string |
値。 |
ユーザーにライセンスを割り当てる
ユーザーのライセンスを追加または削除します。 ライセンスに関連付けられている特定のプランを有効または無効にすることもできます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Cloud User Hub 組織 ID。
|
organizationId | True | string |
Cloud User Hub 組織の識別し。 |
|
Microsoft object id of the user.
|
microsoftObjectId | True | string |
ユーザーの Microsoft オブジェクト ID。 |
|
disabledPlans
|
disabledPlans | array of |
無効化されたプラン。 |
|
|
Sku id
|
skuId | string |
Microsoft ライセンスの Sku ID。 |
|
|
Remove licenses
|
removeLicenses | array of |
削除するライセンスを識別する GUID のコレクション。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
価値
|
value | array of object |
値。 |
|
Id
|
value.id | string |
ライセンス オブジェクトの ID。 |
|
Sku id
|
value.skuId | string |
Microsoft の SKU ID。 |
|
Sku partnumber
|
value.skuPartNumber | string |
Microsoft Sku の部品番号。 |
|
servicePlans
|
value.servicePlans | array of object |
サービス プラン。 |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Serviceplan の ID。 |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Serviceplan の名前。 |
|
provisioningStatus
|
value.servicePlans.provisioningStatus | string |
プロビジョニングの状態。 |
|
appliesTo
|
value.servicePlans.appliesTo | string |
適用対象。 |
ユーザーの詳細を取得する
Microsoft オブジェクト ID でユーザーを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Cloud User Hub 組織 ID。
|
organizationId | True | string |
Cloud User Hub 組織の識別し。 |
|
Microsoft object id of the user.
|
microsoftObjectId | True | string |
ユーザーの Microsoft オブジェクト ID。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Account enabled
|
accountEnabled | boolean |
アカウントが有効または無効。 |
|
Employee id
|
employeeId | string |
ユーザーの従業員 ID。 |
|
Display name
|
displayName | string |
ユーザーの表示名。 |
|
指定された名前
|
givenName | string |
ユーザーの指定された名前。 |
|
姓
|
surname | string |
ユーザーの姓。 |
|
User principal name
|
userPrincipalName | string |
ユーザーのユーザー プリンシパル名。 |
|
役職
|
jobTitle | string |
ユーザーの役職です。 |
|
学科
|
department | string |
ユーザーの部署。 |
|
会社名
|
companyName | string |
ユーザーの会社名。 |
|
Usagelocation
|
usageLocation | string |
ユーザーの使用場所。 |
|
番地
|
streetAddress | string |
ユーザーの通り名。 |
|
City
|
city | string |
ユーザーの市区町村。 |
|
状態
|
state | string |
ユーザーの都道府県。 |
|
Postal code
|
postalCode | string |
ユーザーの郵便番号。 |
|
Country
|
country | string |
ユーザーの国コード。 |
ユーザーを作成
要求本文には、作成するユーザーが含まれています。 少なくとも、ユーザーに必要なプロパティを指定する必要があります。 オプションで、他の書き込み可能なプロパティを指定できます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Cloud User Hub 組織 ID。
|
organizationId | True | string |
Cloud User Hub 組織の識別し。 |
|
Account enabled
|
accountEnabled | boolean |
アカウントが有効または無効。 |
|
|
Display name
|
displayName | string |
ユーザーの表示名。 |
|
|
Mail nickname
|
mailNickname | string |
ユーザーのメール ニックネーム。 |
|
|
User principal name
|
userPrincipalName | string |
ユーザーのユーザー プリンシパル名。 |
|
|
Force change password next signin
|
forceChangePasswordNextSignIn | boolean |
ユーザーは次のサインインで一時パスワードを強制的に変更します。 |
|
|
Password
|
password | string |
ユーザーの新しいパスワード。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
OData context
|
@odata.context | string |
OData コンテキスト。 |
|
Id
|
id | string |
Cloud User Hub の識別子。 |
|
businessPhones
|
businessPhones | array of string |
ユーザーの勤務先電話番号。 |
|
表示名称
|
displayName | string |
ユーザーの表示名。 |
|
指定された名前
|
givenName | string |
与えられた名前。 |
|
Job title
|
jobTitle | string |
ユーザーの役職です。 |
|
Mail
|
string |
ユーザーのメール アドレス。 |
|
|
Mobile phone
|
mobilePhone | string |
ユーザーの携帯電話番号。 |
|
Office location
|
officeLocation | string |
ユーザーのオフィスの場所。 |
|
Preferred language
|
preferredLanguage | string |
Azure AD で構成されている優先言語。 |
|
Surname
|
surname | string |
ユーザーの姓。 |
|
User Principal Name
|
userPrincipalName | string |
ユーザーのユーザー プリンシパル名。 |
ユーザーを削除
ユーザーを削除します。 削除すると、ユーザー リソースは一時コンテナに移動され、30 日以内に復元できます。 その後、それらは完全に削除されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Cloud User Hub 組織 ID。
|
organizationId | True | string |
Cloud User Hub 組織の識別し。 |
|
Microsoft object id of the user.
|
microsoftObjectId | True | string |
ユーザーの Microsoft オブジェクト ID。 |
ユーザーを取得する
ユーザー オブジェクトの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー フィルター。
|
$filter | True | string |
組織内のユーザーをフィルタリングします。 用途: ('{organizationId}') の組織 ID。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
OData count
|
@odata.count | integer |
OData カウント。 |
|
価値
|
value | array of object |
値。 |
|
組織 ID
|
value.organizationId | string |
Cloud User Hub 組織の識別し。 |
|
Microsoft object identifier
|
value.microsoftObjectIdentifier | string |
ユーザーの Microsoft オブジェクト ID。 |
|
User principal name
|
value.upn | string |
ユーザーのユーザー プリンシパル名。 |
|
First name
|
value.firstName | string |
ユーザーの名です。 |
|
Last name
|
value.lastName | string |
ユーザーの姓です。 |
|
Display name
|
value.displayName | string |
ユーザーの表示名。 |
|
Language
|
value.language | string |
ユーザーの言語です。 |
|
Usage location
|
value.usageLocation | string |
ユーザーの使用場所。 |
|
Id
|
value.id | string |
ユーザーの Cloud User Hub 識別子。 |
|
作成日
|
value.createdOn | string |
作成日。 |
|
Modified on
|
value.modifiedOn | string |
更新日時。 |
単一ユーザージョブの詳細を取得する
単一ユーザー ジョブの詳細を取得して、特定のコマンド ブロックによる検証をアクションする。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
組織 ID
|
organizationId | True | string |
形式 - uuid。 組織を表す一意識別子です。 |
|
コマンド ブロック ID
|
commandBlockId | True | string |
形式 - uuid。 コマンド ブロックの一意識別子。 |
|
ジョブ ID
|
jobId | True | string |
形式 - uuid。 ジョブの一意の識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Id
|
id | string |
ID。 |
|
コマンド ブロック ID
|
commandBlockId | string |
コマンド ブロックの識別子。 |
|
コマンド設定名
|
commandSetName | string |
コマンド設定名。 |
|
コマンド設定 ID
|
commandSetId | string |
コマンド設定識別子。 |
|
コマンド設定ブロック ID
|
commandSetBlockId | string |
コマンド設定ブロックの識別子。 |
|
ユーザー ID
|
userId | string |
ユーザー識別子。 |
|
ユーザー UPN
|
userUpn | string |
ユーザーのユーザー プリンシパル名。 |
|
Group id
|
groupId | string |
グループ識別子。 |
|
Group name
|
groupName | string |
グループ名。 |
|
組織 ID
|
organizationId | string |
組織の識別子。 |
|
組織名
|
organizationName | string |
組織名。 |
|
アクター UPN
|
actorUserUpn | string |
アクター ユーザー プリンシパル名。 |
|
アクター組織 ID
|
actorOrganizationId | string |
アクター組織の識別子。 |
|
アクター組織名
|
actorOrganizationName | string |
アクター組織名。 |
|
Status
|
status | string |
状態。 |
|
実行日
|
executedOn | string |
実行日。 |
|
コマンド ブロックのテクニカル ID。
|
commandBlockTechnicalIdentifier | string |
コマンド ブロックのテクニカル ID。 |
|
コマンド ブロック バージョン
|
commandBlockVersion | integer |
コマンド ブロックのバージョン。 |
|
layoutGroups
|
output.body.layoutGroups | array of object |
レイアウト グループの形式。 |
|
layoutGroupFormats
|
output.body.layoutGroups.layoutGroupFormats | array of object |
レイアウト グループの形式。 |
|
タイプ
|
output.body.layoutGroups.layoutGroupFormats.type | string |
タイプ。 |
|
property
|
output.body.layoutGroups.layoutGroupFormats.property | string |
プロパティ。 |
|
properties
|
output.body.layoutGroups.layoutGroupFormats.properties | array of string |
プロパティ。 |
|
parameters
|
output.body.parameters | array of object |
パラメーター。 |
|
テクニカル ID
|
output.body.parameters.technicalIdentifier | string |
技術的な識別子。 |
|
価値
|
output.body.parameters.value | string |
値。 |
|
Schema
|
output.body.parameters.schema | string |
スキーマ。 |
|
コマンド セット
|
output.body.parameters.placeholderEnabled.commandSet | boolean |
コマンド セット。 |
|
コマンド ブロック
|
output.body.parameters.placeholderEnabled.commandBlock | boolean |
コマンド ブロック。 |
|
エラー コード
|
output.errorCode | string |
エラー コードです。 |
|
Success
|
output.isSuccess | boolean |
正常に完了しました。 |
|
layoutGroups
|
input.layoutGroups | array of object |
グループのレイアウト。 |
|
layoutGroupFormats
|
input.layoutGroups.layoutGroupFormats | array of object |
レイアウト グループの形式。 |
|
タイプ
|
input.layoutGroups.layoutGroupFormats.type | string |
タイプ。 |
|
property
|
input.layoutGroups.layoutGroupFormats.property | string |
プロパティ。 |
|
properties
|
input.layoutGroups.layoutGroupFormats.properties | array of string |
プロパティ。 |
|
複数の組織
|
input.multiSelection.multipleOrganizations | boolean |
複数の組織。 |
|
複数ユーザー
|
input.multiSelection.multipleUsers | boolean |
複数ユーザー。 |
|
parameters
|
input.parameters | array of object |
パラメーター。 |
|
テクニカル ID
|
input.parameters.technicalIdentifier | string |
技術的な識別子。 |
|
価値
|
input.parameters.value | string |
値。 |
|
規定値
|
input.parameters.defaultValue | string |
規定値。 |
|
タイプ
|
input.parameters.schema.type | string |
タイプ。 |
|
Format
|
input.parameters.schema.format | string |
フォーマット。 |
|
Pattern
|
input.parameters.schema.pattern | string |
パターン。 |
|
最小長
|
input.parameters.schema.minLength | string |
最小長。 |
|
コマンド セット
|
input.parameters.placeholderEnabled.commandSet | boolean |
コマンド セット。 |
|
コマンド ブロック
|
input.parameters.placeholderEnabled.commandBlock | boolean |
コマンド ブロック。 |
|
linkedCommandBlocks
|
input.parameters.placeholderEnabled.linkedCommandBlocks | array of object |
リンクされたコマンドブロック。 |
|
technicalIdentifier
|
input.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier | string |
技術的な識別子。 |
|
version
|
input.parameters.placeholderEnabled.linkedCommandBlocks.version | integer |
バージョン。 |
承認されたすべての組織のコマンド ブロック ジョブの統計を取得
表示権限のあるコマンド ブロックのコマンド ブロック ジョブで統計を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
カテゴリ ID
|
categoryId | True | string |
形式 - uuid。 カテゴリを表す一意の識別子です。 |
|
フィルターの選択
|
$select | string |
OData フィルターを選択します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
OData context
|
@odata.context | string |
OData コンテキスト。 |
|
タイプ
|
type | string |
タイプ。 |
|
カテゴリー
|
category | string |
カテゴリ。 |
|
期間
|
period | string |
期間。 |
|
Completed
|
completed | integer |
完了。 |
|
キュー登録済み
|
queued | integer |
キュー済み。 |
|
失敗
|
failed | integer |
失敗しました。 |
承認されたすべての組織のコマンド ブロック ジョブを取得する
表示権限のあるコマンド ブロックのコマンド ブロック ジョブを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
$top 項目
|
$top | string |
最初のストップ項目のみを返します。 |
|
|
$skip 項目
|
$skip | string |
スキップする項目の数。 |
|
|
フィルターの選択
|
$select | string |
OData フィルターを選択します。 |
|
|
並べ替え順
|
$orderby | string |
レコードのコレクションを並べ替えるために使用される値を決定します。 |
|
|
フィルター
|
$filter | string |
レコードが返されるためにtrueと評価される必要がある関数。 |
|
|
数
|
$count | string |
アイテムの数をコレクションに含めるかどうかを決定します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
OData context
|
@odata.context | string |
OData コンテキスト。 |
|
OData count
|
@odata.count | integer |
OData カウント。 |
|
OData の次のリンク
|
@odata.nextLink | string |
OData の次のリンク |
|
価値
|
value | array of object |
値。 |
|
Id
|
value.id | string |
識別子。 |
|
コマンド ブロック ID
|
value.commandBlockId | string |
コマンド ブロックの識別子。 |
|
コマンド設定名
|
value.commandSetName | string |
コマンド設定名。 |
|
コマンド設定 ID
|
value.commandSetId | string |
コマンド設定識別子 |
|
コマンド設定ブロック ID
|
value.commandSetBlockId | string |
コマンド設定ブロックの識別子。 |
|
ユーザー ID
|
value.userId | string |
ユーザー識別子。 |
|
User principal name
|
value.userUpn | string |
ユーザー プリンシパル名。 |
|
Group id
|
value.groupId | string |
グループ識別子。 |
|
Group name
|
value.groupName | string |
グループ名。 |
|
組織 ID
|
value.organizationId | string |
組織の識別子。 |
|
組織名
|
value.organizationName | string |
組織名。 |
|
アクター ユーザー UPN
|
value.actorUserUpn | string |
アクター ユーザー プリンシパル名。 |
|
アクター組織 ID
|
value.actorOrganizationId | string |
アクター組織の識別子。 |
|
アクター組織名
|
value.actorOrganizationName | string |
アクター組織名。 |
|
Status
|
value.status | string |
状態。 |
|
実行日
|
value.executedOn | string |
実行日。 |
|
コマンド ブロックのテクニカル ID。
|
value.commandBlockTechnicalIdentifier | string |
コマンド ブロックのテクニカル ID。 |
|
コマンド ブロック バージョン
|
value.commandBlockVersion | integer |
コマンド ブロックのバージョン。 |
|
計画された実行
|
value.plannedExecution | string |
計画された実行。 |
|
スケジュール ID
|
value.scheduleId | string |
スケジュールの識別子。 |
|
スケジュール名
|
value.scheduleName | string |
スケジュール名。 |
特定の組織のコマンド ブロック ジョブを取得する
表示権限のあるコマンド ブロックのコマンド ブロック ジョブを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
組織 ID。
|
organizationId | True | string |
形式 - uuid。 組織を表す一意識別子です。 |
|
$top 項目
|
$top | string |
最初のストップ項目のみを返します。 |
|
|
$skip 項目
|
$skip | string |
スキップする項目の数。 |
|
|
フィルターの選択
|
$select | string |
OData フィルターを選択します。 |
|
|
並べ替え順
|
$orderby | string |
レコードのコレクションを並べ替えるために使用される値を決定します。 |
|
|
フィルター
|
$filter | string |
レコードが返されるためにtrueと評価される必要がある関数。 |
|
|
数
|
$count | string |
アイテムの数をコレクションに含めるかどうかを決定します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
OData context
|
@odata.context | string |
OData コンテキスト。 |
|
OData count
|
@odata.count | integer |
OData カウント。 |
|
OData nextlink
|
@odata.nextLink | string |
OData nextlink. |
|
価値
|
value | array of object |
値。 |
|
Id
|
value.id | string |
ID。 |
|
コマンド ブロック ID
|
value.commandBlockId | string |
コマンド ブロックの識別子。 |
|
コマンド設定名
|
value.commandSetName | string |
コマンド設定名。 |
|
コマンド設定 ID
|
value.commandSetId | string |
コマンド設定識別子。 |
|
コマンド設定ブロック ID
|
value.commandSetBlockId | string |
コマンド設定ブロックの識別子。 |
|
ユーザー ID
|
value.userId | string |
ユーザー識別子。 |
|
ユーザー UPN
|
value.userUpn | string |
ユーザー プリンシパル名。 |
|
Group id
|
value.groupId | string |
グループ識別子。 |
|
Group name
|
value.groupName | string |
グループ名。 |
|
組織 ID
|
value.organizationId | string |
組織の識別子。 |
|
組織名
|
value.organizationName | string |
組織名。 |
|
アクター ユーザー プリンシパル名
|
value.actorUserUpn | string |
アクター ユーザー プリンシパル名。 |
|
アクター組織 ID
|
value.actorOrganizationId | string |
アクター組織の識別子。 |
|
アクター組織名
|
value.actorOrganizationName | string |
アクター組織名。 |
|
Status
|
value.status | string |
状態。 |
|
実行日
|
value.executedOn | string |
実行日。 |
|
コマンド ブロックのテクニカル ID。
|
value.commandBlockTechnicalIdentifier | string |
コマンド ブロックのテクニカル ID。 |
|
コマンド ブロック バージョン
|
value.commandBlockVersion | integer |
コマンド ブロックのバージョン。 |
|
計画された実行
|
value.plannedExecution | string |
計画された実行。 |
|
スケジュール ID
|
value.scheduleId | string |
スケジュールの識別子。 |
|
スケジュール名
|
value.scheduleName | string |
スケジュール名。 |
組織がサブスクライブした SKU を取得する
組織が取得した商用サブスクリプションのリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Cloud User Hub 組織 ID。
|
organizationId | True | string |
Cloud User Hub 組織の識別し。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
価値
|
value | array of object |
値。 |
|
機能ステータス
|
value.capabilityStatus | string |
Microsoft sku の機能ステータス。 |
|
消費ユニット
|
value.consumedUnits | integer |
この sku の消費ユニット。 |
|
Id
|
value.id | string |
サブスクライブされた sku オブジェクトの ID。 |
|
Sku id
|
value.skuId | string |
Microsoft ライセンスの Sku ID。 |
|
Sku partnumber
|
value.skuPartNumber | string |
Microsoft ライセンスの Sku の部品番号。 |
|
適用対象
|
value.appliesTo | string |
ユーザーまたは組織に適用されます。 |
|
Enabled
|
value.prepaidUnits.enabled | integer |
有効化されたサブスクライブされた SKU。 |
|
中止
|
value.prepaidUnits.suspended | integer |
中止されたサブスクライブされた sku。 |
|
警告
|
value.prepaidUnits.warning | integer |
サブスクライブされた警告付きの sku。 |
|
servicePlans
|
value.servicePlans | array of object |
サービス プラン。 |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Serviceplan の ID。 |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Serviceplan の名前。 |
|
provisioningStatus
|
value.servicePlans.provisioningStatus | string |
プロビジョニングの状態。 |
|
appliesTo
|
value.servicePlans.appliesTo | string |
適用対象。 |
組織のコマンド ブロック ジョブを追加する
コマンド ブロック ジョブを追加します。 プロバイダーとアクションの検証は、特定のコマンド ブロックに基づいています。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
組織 ID
|
organizationId | True | string |
形式 - uuid。 組織を表す一意識別子です。 |
|
コマンド ブロック ID
|
commandBlockId | True | string |
形式 - uuid。 コマンド ブロックの一意識別子。 |
|
ターゲット組織 ID
|
targetOrganizationId | True | string |
形式 - uuid。 ターゲット組織の一意の識別子。 |
|
テクニカル ID
|
technicalIdentifier | string |
技術的な識別子 |
|
|
価値
|
value | string |
値。 |
|
|
スケジュール ID
|
scheduleId | string |
スケジュールの識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
価値
|
value | string |
値。 |
複数の組織を取得する
表示を許可されているすべての組織を取得します。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
OData count
|
@odata.count | integer |
OData カウント。 |
|
価値
|
value | array of object |
値。 |
|
件名
|
value.name | string |
Azure AD 組織の名前。 |
|
Microsoft tenantId
|
value.microsoftTenantId | string |
組織の Microsoft テナント ID。 |
|
Created on
|
value.createdOn | string |
作成日。 |
|
Modified on
|
value.modifiedOn | string |
更新日時。 |
|
Id
|
value.id | string |
Cloud User Hub の識別子。 |
購読を取得する
パートナーの顧客のすべてのサブスクリプションを、Active Directory テナント ID によって取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Cloud User Hub のパートナー ID。
|
partnerId | True | string |
Cloud User Hub のパートナー ID。 |
|
Cloud User Hub の顧客 ID。
|
customerId | True | string |
Cloud User Hub の顧客 ID。 |
|
顧客の Microsoft テナント ID。
|
tenantId | True | string |
顧客の Microsoft テナント ID。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
総数
|
totalCount | integer |
サブスクリプション オブジェクトの総数。 |
|
items
|
items | array of object |
品目。 |
|
Id
|
items.id | string |
サブスクリプションの ID。 |
|
Entitlement id
|
items.entitlementId | string |
サブスクリプションのエンタイトルメント ID。 |
|
フレンドリ名
|
items.friendlyName | string |
サブスクリプションのフレンドリ名。 |
|
数量
|
items.quantity | integer |
サブスクリプションの数量。 |
|
単位の種類
|
items.unitType | string |
サブスクリプションの単位の種類。 |
|
作成日時
|
items.creationDate | string |
サブスクリプションの作成日。 |
|
Effective start date
|
items.effectiveStartDate | string |
サブスクリプションが有効になる開始日。 |
|
Commitment end date
|
items.commitmentEndDate | string |
サブスクリプションのコミットメント終了日。 |
|
Status
|
items.status | string |
サブスクリプションの状態。 |
|
Auto renew
|
items.autoRenewEnabled | boolean |
サブスクリプションの自動更新が有効になっているかどうかを示します。 |
|
請求の種類
|
items.billingType | string |
サブスクリプションの請求の種類。 |
|
契約の種類
|
items.contractType | string |
サブスクリプションの連絡先の種類。 |
|
URI
|
items.links.offer.uri | string |
サブスクリプションの URL。 |
|
メソッド
|
items.links.offer.method | string |
サブスクリプションの方法。 |
|
headers
|
items.links.offer.headers | array of |
ヘッダー。 |
|
URI
|
items.links.self.uri | string |
サブスクリプションの URL。 |
|
メソッド
|
items.links.self.method | string |
サブスクリプションの方法。 |
|
headers
|
items.links.self.headers | array of |
ヘッダー。 |
|
Order id
|
items.orderId | string |
サブスクリプションの受注 ID。 |
|
Etag
|
items.attributes.etag | string |
サブスクリプションの Etag。 |
|
Object type
|
items.attributes.objectType | string |
サブスクリプションのオブジェクトの種類。 |
|
Object type
|
attributes.objectType | string |
サブスクリプションのオブジェクトの種類。 |