このページの内容

APIリファレンス：組織

warning

テナントを削除すると、そのテナントのすべてのプロセス、データセット、ユーザー割り当てが完全に削除されます。この操作は元に戻せません。認証に使用しているテナントは削除できません。

warning

ユーザーを組織から削除すると、組織内のすべてのテナントへのアクセス権が取り消されます。

組織では、複数のテナントを1つのエンティティにまとめて管理します。

テナントの組織を取得

テナントスコープのAPIキーで読み取れます。組織スコープのキーも使用できます。

エンドポイント： GET /v1/tenant/{tenantId}/organization

認証： テナントまたは組織スコープのAPIキー · readスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：`uuid`

レスポンス（200）：

組織の詳細

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"contactEmail": "string",
	"isActive": true,
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"createdBy": "00000000-0000-0000-0000-000000000000"
}

フィールド	型	必須	説明
id	string	はい	形式：`uuid`
displayName	string	はい	デフォルト：`""` 最大長：128
createdAt	string	はい	形式：`date-time`
contactEmail	string	はい	形式：`email`
isActive	boolean	はい	デフォルト：`true`
allowedLogins	object	はい
createdBy	string	はい	形式：`uuid`

エラー：

401 APIキーがない、無効、無効化済み、または期限切れです
404 リソースが見つかりません

組織のシートキャパシティと自動同期ポリシーを取得

組織全体で購入済みおよび使用中の席数を階層別（プロセス基盤、プロセスアーキテクチャ、プロセスインテリジェンス）に返します。無料ビューアーの許容数、自動同期の対象、席数の差異に関する説明（エンジンがいつ何を実行するか）、請求間隔、externalApiSeatPolicyも含まれます。テナント単位のAPIキーで読み取り可能です。{tenantId}パスパラメータはコンテキストテナント（組織単位のキーが属する組織）を示し、操作対象ではありません。

エンドポイント： GET /v1/tenant/{tenantId}/organization/billing/seats

認証： テナントまたは組織スコープのAPIキー · readスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：`uuid`

レスポンス（200）：

シートキャパシティ

{
	"contractType": "free",
	"isTrial": true,
	"purchased": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseBillable": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseFree": 0,
	"totalBillable": 0,
	"freeViewerAllowance": 0,
	"freeViewerOverAllowance": 0,
	"fixedOverage": 0,
	"target": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"drift": [
		{
			"rung": "foundation",
			"paid": 0,
			"actual": 0,
			"state": "equal",
			"buffer": 0
		}
	],
	"interval": "month",
	"nextBilledAt": "string",
	"externalApiSeatPolicy": "autoBill"
}

フィールド	型	必須	説明
contractType	`free` \| `selfServe` \| `fixed` \| `unlimited`	はい	許可される値：`free`、`selfServe`、`fixed`、`unlimited`
isTrial	boolean	はい
purchased	object	はい
inUseBillable	object	はい
inUseFree	number	はい
totalBillable	number	はい
freeViewerAllowance	number	はい
freeViewerOverAllowance	number	はい
fixedOverage	number	はい
target	object	はい
drift	object[]	はい
interval	`month` \| `year`	はい	許可される値：`month`、`year`
nextBilledAt	string	はい
externalApiSeatPolicy	`autoBill` \| `requireCapacity`	はい	許可される値：`autoBill`、`requireCapacity`

エラー：

401 APIキーがない、無効、無効化済み、または期限切れです
404 リソースが見つかりません

組織全体の統計を取得

{tenantId}パスパラメーターはコンテキストテナント（組織スコープのキーが属する組織のテナント）であり、操作対象ではありません。

エンドポイント： GET /v1/tenant/{tenantId}/organization/statistics

認証： 組織スコープのAPIキー · readスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：`uuid`

レスポンス（200）：

組織の統計

{
	"userCount": 0,
	"tenantCount": 0,
	"tenantStatistics": [
		{
			"tenantId": "00000000-0000-0000-0000-000000000000",
			"uploadedDataSize": 0,
			"uploadedDataCount": 0,
			"modelCount": 0,
			"simulationCount": 0,
			"userCount": 0
		}
	]
}

フィールド	型	必須
userCount	number	はい
tenantCount	number	はい
tenantStatistics	object[]	はい

エラー：

401 APIキーがない、無効、無効化済み、または期限切れです

組織内のすべてのテナントを一覧表示

{tenantId}パスパラメーターはコンテキストテナント（組織スコープのキーが属する組織のテナント）であり、操作対象ではありません。

エンドポイント： GET /v1/tenant/{tenantId}/organization/tenants

認証： 組織スコープのAPIキー · readスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：`uuid`
limit	integer	クエリ	いいえ	返す項目の最大数
offset	integer	クエリ	いいえ	スキップする項目数

レスポンス（200）：

テナント一覧

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"createdBy": "00000000-0000-0000-0000-000000000000",
		"createdAt": "2024-03-15T16:30:00Z",
		"displayName": "string",
		"contactEmail": "string",
		"isActive": true,
		"shortName": "string",
		"useOrganizationTheme": true,
		"description": "string",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"allowedLogins": {
			"Microsoft": true,
			"Google": true,
			"LinkedIn": true
		},
		"url": "string"
	}
]

エラー：

401 APIキーがない、無効、無効化済み、または期限切れです

組織に新しいテナントを作成（組織スコープのAPIキーが必要）

{tenantId}パスパラメーターはコンテキストテナント（組織スコープのキーが属する組織のテナント）であり、操作対象ではありません。

エンドポイント： POST /v1/tenant/{tenantId}/organization/tenants

認証： 組織スコープのAPIキー · writeスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：`uuid`

リクエスト本文：

{
	"displayName": "string",
	"shortName": "string",
	"description": "string"
}

フィールド	型	必須	説明
displayName	string	いいえ	最大長：128
shortName	string	はい
description	string	いいえ	最大長：200

レスポンス（201）：

テナントを作成しました

{
	"id": "00000000-0000-0000-0000-000000000000",
	"createdBy": "00000000-0000-0000-0000-000000000000",
	"createdAt": "2024-03-15T16:30:00Z",
	"displayName": "string",
	"contactEmail": "string",
	"isActive": true,
	"shortName": "string",
	"useOrganizationTheme": true,
	"description": "string",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"url": "string"
}

フィールド	型	必須	説明
id	string	はい	形式：`uuid`
createdBy	string	はい	形式：`uuid`
createdAt	string	はい	形式：`date-time`
displayName	string	はい	デフォルト：`""` 最大長：128
contactEmail	string	はい	形式：`email`
isActive	boolean	はい	デフォルト：`true`
shortName	string	はい
useOrganizationTheme	boolean	はい	デフォルト：`true`
description	string	はい	最大長：200
organizationId	string	はい	形式：`uuid`
allowedLogins	object	はい
url	string	はい	形式：`uri`

エラー：

400 不正なリクエスト：無効なフィルター式、モデルのないプロセス、サポートされていないアップロード形式、必須フィールドの欠落など
401 APIキーがない、無効、無効化済み、または期限切れです
403 APIキーに必要なスコープまたは組織へのアクセス権がない、テナントが非アクティブ、またはプランでファイル形式が許可されていません
406 値を受け付けられません（予約済みまたは重複したshort nameなど）

組織内のテナントを論理削除（組織スコープのAPIキーが必要）

テナントへのAPIアクセスは直ちに停止します。削除安全期間中はテナントとそのデータが保持され、その後、自動的な完全削除によって削除されます。現在使用しているテナント（コンテキストテナント）は削除できません。

エンドポイント： DELETE /v1/tenant/{tenantId}/organization/tenants/{targetId}

認証： 組織スコープのAPIキー · writeスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：`uuid`
targetId	string	パス	はい	形式：`uuid`

レスポンス（200）：

テナントを削除しました

{
	"success": true,
	"message": "string"
}

フィールド	型	必須	説明
success	boolean	はい
message	string	はい

エラー：

400 不正なリクエスト：無効なフィルター式、モデルのないプロセス、サポートされていないアップロード形式、必須フィールドの欠落など
401 APIキーがない、無効、無効化済み、または期限切れです
403 APIキーに必要なスコープまたは組織へのアクセス権がない、テナントが非アクティブ、またはプランでファイル形式が許可されていません
404 リソースが見つかりません

組織内の論理削除済みテナントを復元（組織スコープのAPIキーが必要）

削除安全期間内で論理削除を取り消します。テナントとそのデータは削除前の状態に戻り、APIアクセスが再開します。{tenantId}パスパラメーターはコンテキストテナント（組織スコープのキーが属する組織のテナント）であり、操作対象ではありません。

エンドポイント： POST /v1/tenant/{tenantId}/organization/tenants/{targetId}/restore

認証： 組織スコープのAPIキー · writeスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：`uuid`
targetId	string	パス	はい	形式：`uuid`

レスポンス（200）：

テナントを復元しました

{
	"success": true,
	"message": "string"
}

フィールド	型	必須	説明
success	boolean	はい
message	string	はい

エラー：

400 不正なリクエスト：無効なフィルター式、モデルのないプロセス、サポートされていないアップロード形式、必須フィールドの欠落など
401 APIキーがない、無効、無効化済み、または期限切れです
403 APIキーに必要なスコープまたは組織へのアクセス権がない、テナントが非アクティブ、またはプランでファイル形式が許可されていません
404 リソースが見つかりません

組織内のすべてのユーザーを一覧表示

{tenantId}パスパラメーターはコンテキストテナント（組織スコープのキーが属する組織のテナント）であり、操作対象ではありません。

エンドポイント： GET /v1/tenant/{tenantId}/organization/users

認証： 組織スコープのAPIキー · readスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：`uuid`
limit	integer	クエリ	いいえ	返す項目の最大数
offset	integer	クエリ	いいえ	スキップする項目数

レスポンス（200）：

組織ユーザー一覧

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"email": "string",
		"firstName": "string",
		"lastName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"lastLoginAt": "2024-03-15T16:30:00Z",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"isActiveInOrganization": true,
		"isAdminInOrganization": true
	}
]

エラー：

401 APIキーがない、無効、無効化済み、または期限切れです

組織ユーザーの設定を更新（組織スコープのAPIキーが必要）

本文のロールフラグ（isAdminInOrganization、isActiveInOrganization）は指定どおりに適用されます。組織スコープのキーは組織管理者にのみ発行してください。{tenantId}パスパラメーターはコンテキストテナント（組織スコープのキーが属する組織のテナント）であり、操作対象ではありません。

エンドポイント： PUT /v1/tenant/{tenantId}/organization/users/{userId}

認証： 組織スコープのAPIキー · writeスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：`uuid`
userId	string	パス	はい	形式：`uuid`

リクエスト本文：

{
	"isActiveInOrganization": true,
	"isAdminInOrganization": true
}

フィールド	型	必須	説明
isActiveInOrganization	boolean	いいえ	ユーザーが組織でアクティブかどうか
isAdminInOrganization	boolean	いいえ	組織管理者権限（指定どおりに適用：組織スコープのキーは組織管理者にのみ発行）

レスポンス（200）：

更新しました

{
	"message": "string"
}

フィールド	型	必須	説明
message	string	はい

エラー：

401 APIキーがない、無効、無効化済み、または期限切れです
403 APIキーに必要なスコープまたは組織へのアクセス権がない、テナントが非アクティブ、またはプランでファイル形式が許可されていません
404 リソースが見つかりません

組織からユーザーを削除（組織スコープのAPIキーが必要）

{tenantId}パスパラメーターはコンテキストテナント（組織スコープのキーが属する組織のテナント）であり、操作対象ではありません。

エンドポイント： DELETE /v1/tenant/{tenantId}/organization/users/{userId}

認証： 組織スコープのAPIキー · writeスコープ

パラメーター：

名前	型	場所	必須	説明
tenantId	string	パス	はい	形式：`uuid`
userId	string	パス	はい	形式：`uuid`

レスポンス（200）：

ユーザーを削除しました

{
	"message": "string"
}

フィールド	型	必須	説明
message	string	はい

エラー：

401 APIキーがない、無効、無効化済み、または期限切れです
403 APIキーに必要なスコープまたは組織へのアクセス権がない、テナントが非アクティブ、またはプランでファイル形式が許可されていません
404 リソースが見つかりません

APIリファレンス：組織

テナントの組織を取得

組織のシートキャパシティと自動同期ポリシーを取得

組織全体の統計を取得

組織内のすべてのテナントを一覧表示

組織に新しいテナントを作成（組織スコープのAPIキーが必要）

組織内のテナントを論理削除（組織スコープのAPIキーが必要）

組織内の論理削除済みテナントを復元（組織スコープのAPIキーが必要）

組織内のすべてのユーザーを一覧表示

組織ユーザーの設定を更新（組織スコープのAPIキーが必要）

組織からユーザーを削除（組織スコープのAPIキーが必要）

関連ドキュメント

APIリファレンス：テナント

APIリファレンス：データ

APIリファレンス：プロセス

APIリファレンス：シミュレーション

APIリファレンス：組織

テナントの組織を取得

組織のシートキャパシティと自動同期ポリシーを取得

組織全体の統計を取得

組織内のすべてのテナントを一覧表示

組織に新しいテナントを作成（組織スコープのAPIキーが必要）

組織内のテナントを論理削除（組織スコープのAPIキーが必要）

組織内の論理削除済みテナントを復元（組織スコープのAPIキーが必要）

組織内のすべてのユーザーを一覧表示

組織ユーザーの設定を更新（組織スコープのAPIキーが必要）

組織からユーザーを削除（組織スコープのAPIキーが必要）

関連ドキュメント

APIリファレンス：テナント

APIリファレンス：データ

APIリファレンス：プロセス

APIリファレンス：シミュレーション

プライバシーを大切にしています