APIリファレンス：組織

組織では、複数のテナントを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 リソースが見つかりません

組織のシート数と自動同期ポリシーを取得

組織全体の各プラン（Process Foundation、Process Architecture、Process Intelligence）について、購入済みシート数と使用中シート数、無料ビューアーの上限、自動同期の目標、シート数の差異に関する説明（システムがいつ何を行うか）、請求間隔、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,
	"inUseDashboardViewers": 0,
	"totalBillable": 0,
	"freeViewerAllowance": 0,
	"freeViewerOverAllowance": 0,
	"dashboardViewerAllowance": 0,
	"dashboardViewerOverAllowance": 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	はい
inUseDashboardViewers	number	はい
totalBillable	number	はい
freeViewerAllowance	number	はい
freeViewerOverAllowance	number	はい
dashboardViewerAllowance	number	はい
dashboardViewerOverAllowance	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
		},
		"tenantType": "normal",
		"url": "string"
	}
]

エラー：

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

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

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

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

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

パラメーター：

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

リクエスト本文：

{
	"displayName": "string",
	"shortName": "string",
	"description": "string",
	"timezone": "string",
	"tenantType": "normal"
}

フィールド	型	必須	説明
displayName	string	いいえ	最大長：128
shortName	string	はい
description	string	いいえ	最大長：200
timezone	string	いいえ	最大長：64
tenantType	normal | sandbox | demo	いいえ	使用可能な値：normal、sandbox、demo

レスポンス（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
	},
	"tenantType": "normal",
	"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	はい
tenantType	normal | sandbox | demo	はい	使用可能な値：normal、sandbox、demo 既定値：normal
url	string	はい	形式：uri

エラー：

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

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

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

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

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

パラメーター：

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

レスポンス（200）：

テナントを削除しました

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

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

エラー：

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

組織内の論理削除されたテナントを復元する（組織スコープのAPIキーが必要）

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

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

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

パラメーター：

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

レスポンス（200）：

テナントを復元しました

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

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

エラー：

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

組織内の全ユーザーを一覧表示

パスパラメーター{tenantId}は操作対象ではなく、コンテキストテナント（組織スコープのキーが属する組織）を指定します。

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

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

パラメーター：

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

レスポンス（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
	}
]

エラー：

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

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

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

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

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

パラメーター：

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

リクエスト本文：

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

フィールド	型	必須	説明
isActiveInOrganization	boolean	いいえ	ユーザーが組織内でアクティブかどうか
isAdminInOrganization	boolean	いいえ	組織管理者の権限（指定どおりに適用されます。組織管理者にのみ組織スコープのキーを発行してください）

レスポンス（200）：

更新しました

{
	"message": "string"
}

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

エラー：

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

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

パスパラメーター{tenantId}は操作対象ではなく、コンテキストテナント（組織スコープのキーが属する組織）を指定します。

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

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

パラメーター：

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

レスポンス（200）：

ユーザーを削除しました

{
	"message": "string"
}

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

エラー：

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