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

テナント情報を取得

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

認証： テナントスコープのAPIキー · read スコープ

パラメーター：

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

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

フィールド	型	必須	説明
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

エラー：

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

テナント設定を更新

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

認証： テナントスコープのAPIキー · write スコープ

パラメーター：

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

リクエスト本文：

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"contactEmail": "string",
	"shortName": "string",
	"description": "string"
}

フィールド	型	必須	説明
id	string	いいえ	形式：uuid
displayName	string	いいえ
contactEmail	string	いいえ
shortName	string	いいえ
description	string	いいえ

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

フィールド	型	必須	説明
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 値を受け付けられません（予約済みまたは重複する短縮名など）

テナント統計を取得（データサイズ、モデル、シミュレーション、ユーザー）

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

認証： テナントスコープのAPIキー · read スコープ

パラメーター：

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

レスポンス（200）：

テナント統計

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

フィールド	型	必須	説明
tenantId	string	はい	形式：uuid
uploadedDataSize	number	はい
uploadedDataCount	number	はい
modelCount	number	はい
simulationCount	number	はい
userCount	number	はい

エラー：

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

テナント内のユーザー一覧

一致するユーザーをJSON配列として返します。合計件数は含まれません。limit／offsetでページングしてください。

エンドポイント： GET /v1/tenant/{tenantId}/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",
		"tenantId": "00000000-0000-0000-0000-000000000000",
		"isActiveInTenant": true,
		"isAdminInTenant": true,
		"access": "none",
		"isDashboardViewer": true,
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"isActiveInOrganization": true,
		"isAdminInOrganization": true
	}
]

エラー：

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

テナントにユーザーを追加（招待メールは送信されません）

本文のロールフィールド（isAdminInTenant、access：none|portalViewer|designer|architect|intelligence、isDashboardViewer）は記載どおりに処理されます。このエンドポイントではテナント管理者のすべての操作が可能なため、書き込みスコープのキーは信頼できる呼び出し元にのみ発行してください。ダッシュボードの閲覧はisDashboardViewerのブール値で指定します。従来の読み取り専用viewer階層は削除されています。

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

認証： テナントスコープのAPIキー · write スコープ

パラメーター：

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

リクエスト本文：

{
	"email": "string",
	"firstName": "string",
	"lastName": "string",
	"isActiveInTenant": true,
	"isAdminInTenant": true,
	"access": "none",
	"isDashboardViewer": true,
	"preferredLocale": "en"
}

フィールド	型	必須	説明
email	string	はい	ユーザーのメールアドレス（ログインIDも兼ねます） 形式：email
firstName	string	いいえ	任意の名 最大長：64
lastName	string	いいえ	任意の姓 最大長：64
isActiveInTenant	boolean	いいえ	このテナントでユーザーが有効かどうか
isAdminInTenant	boolean	いいえ	このテナントでの管理者権限（記載どおりに処理：テナント管理者のすべての操作が可能）
access	none | portalViewer | designer | architect | intelligence	いいえ	単一選択のシート：none | portalViewer | designer | architect | intelligence 許可される値：none、portalViewer、designer、architect、intelligence
isDashboardViewer	boolean	いいえ	ユーザーが読み取り専用でダッシュボードを閲覧できるかどうか
preferredLocale	en | zh | es | fr | de | pt | it | nl | ja | tr	いいえ	ユーザーが優先するUIロケール 許可される値：en、zh、es、fr、de、pt、it、nl、ja、tr

レスポンス（201）：

ユーザーを追加しました

{
	"id": "string",
	"message": "string"
}

フィールド	型	必須	説明
id	string	はい	追加したユーザーのID
message	string	はい

エラー：

• 401 APIキーがない、無効、無効化済み、または期限切れ
• 409 リクエストが現在の状態と競合しています（シート制限またはIDの再利用など）

ユーザーのテナント設定を更新

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

認証： テナントスコープのAPIキー · write スコープ

パラメーター：

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

リクエスト本文：

{
	"isActiveInTenant": true,
	"isAdminInTenant": true,
	"access": "none",
	"isDashboardViewer": true
}

フィールド	型	必須	説明
isActiveInTenant	boolean	いいえ	このテナントでユーザーが有効かどうか
isAdminInTenant	boolean	いいえ	このテナントでの管理者権限（記載どおりに処理：テナント管理者のすべての操作が可能）
access	none | portalViewer | designer | architect | intelligence	いいえ	単一選択のシート：none | portalViewer | designer | architect | intelligence。ダッシュボードの閲覧はisDashboardViewerのブール値で指定します。 許可される値：none、portalViewer、designer、architect、intelligence
isDashboardViewer	boolean	いいえ	ユーザーが読み取り専用でダッシュボードを閲覧できるかどうか

レスポンス（200）：

更新しました

{
	"message": "string"
}

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

エラー：

• 400 不正なリクエスト：無効なフィルター式、モデルのないプロセス、サポートされていないアップロード形式、必須フィールドの欠落など
• 401 APIキーがない、無効、無効化済み、または期限切れ
• 404 リソースが見つかりません

テナントからユーザーを削除

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

認証： テナントスコープのAPIキー · write スコープ

パラメーター：

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

レスポンス（200）：

ユーザーを削除しました

{
	"message": "string"
}

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

エラー：

• 400 不正なリクエスト：無効なフィルター式、モデルのないプロセス、サポートされていないアップロード形式、必須フィールドの欠落など
• 401 APIキーがない、無効、無効化済み、または期限切れ
• 404 リソースが見つかりません

ユーザー用のワンタイムログイン引き継ぎトークンを発行

ユーザー、テナント、組織に紐付いた1回限りのトークン（有効期間60秒）と、ユーザーのブラウザーを移動させるurlを返します。ユーザーのブラウザーでURLを開くと、メールリンクやなりすましを使わず、認証済みの状態でProcessMindに移動します。ユーザー自身のセッションが作成されます。APIキーに専用のsessionsスコープが必要です。組織スコープのキーでは組織内の任意のテナントに属するユーザー用に発行できますが、テナントスコープのキーでは、そのキー自身のテナントに属するユーザーに限られます。トークンはパスワードと同等に扱ってください。トークンは1回だけ返され、ログには記録されず、キーまたはユーザーを無効にすると取り消されます。

エンドポイント： POST /v1/tenant/{tenantId}/users/{userId}/login-token

認証： テナントまたは組織スコープのAPIキー · sessions スコープ · レート制限2 req/s（バースト4）

パラメーター：

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

リクエスト本文：

任意の遷移先パス（相対アプリパス。例：「app」または「app/dashboards」）

{
	"path": "string"
}

フィールド	型	必須	説明
path	string	いいえ	最大長：512

レスポンス（200）：

ログイン引き継ぎトークン

{
	"token": "string",
	"url": "string",
	"expiresInSeconds": 0,
	"expiresAt": "2024-03-15T16:30:00Z"
}

フィールド	型	必須	説明
token	string	はい
url	string	はい
expiresInSeconds	number	はい
expiresAt	string	はい	形式：date-time

エラー：

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

APIキーは連携を認証するために使用します。組織スコープのキーでは、組織内の任意のテナントのキーを発行および管理できます。

テナントのAPIキー一覧

組織スコープのAPIキーが必要です。シークレットは返されません。

エンドポイント： GET /v1/tenant/{tenantId}/api-keys

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

パラメーター：

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

レスポンス（200）：

APIキー一覧

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"tenantId": "00000000-0000-0000-0000-000000000000",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"partialKey": "string",
		"enabled": true,
		"createdAt": "2024-03-15T16:30:00Z",
		"lastUsedAt": "2024-03-15T16:30:00Z",
		"expiresAt": "2024-03-15T16:30:00Z",
		"scope": {
			"read": true,
			"write": true,
			"uploadData": true,
			"sessions": true
		}
	}
]

エラー：

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

テナントスコープのAPIキーを作成

組織スコープの書き込みキーが必要です。シークレットはサーバー側で作成され、レスポンスで1回だけ返されます。安全に保存してください。保持されるのはハッシュのみです。

エンドポイント： POST /v1/tenant/{tenantId}/api-keys

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

パラメーター：

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

リクエスト本文：

{
	"displayName": "string",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"enabled": true,
	"expiresAt": "2024-03-15T16:30:00Z"
}

フィールド	型	必須	説明
displayName	string	はい	最大長：128
scope	object	いいえ
enabled	boolean	いいえ
expiresAt	string	いいえ	形式：date-time

レスポンス（201）：

APIキーを作成しました（1回限りのシークレットを含む）

{
	"id": "00000000-0000-0000-0000-000000000000",
	"tenantId": "00000000-0000-0000-0000-000000000000",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"partialKey": "string",
	"enabled": true,
	"createdAt": "2024-03-15T16:30:00Z",
	"lastUsedAt": "2024-03-15T16:30:00Z",
	"expiresAt": "2024-03-15T16:30:00Z",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"secret": "string"
}

フィールド	型	必須	説明
id	string	はい	形式：uuid
tenantId	string	はい	形式：uuid
organizationId	string	はい	形式：uuid
displayName	string	はい	最大長：128
partialKey	string	はい	最大長：128
enabled	boolean	はい	デフォルト：true
createdAt	string	はい	形式：date-time
lastUsedAt	string	はい	形式：date-time
expiresAt	string	はい	形式：date-time
scope	object	はい
secret	string	はい	最大長：128

エラー：

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

テナントスコープのAPIキーを更新

組織スコープの書き込みキーが必要です。スコープフィールドは保存済みのスコープと統合されます。

エンドポイント： PUT /v1/tenant/{tenantId}/api-keys/{keyId}

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

パラメーター：

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

リクエスト本文：

{
	"displayName": "string",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"enabled": true,
	"expiresAt": "2024-03-15T16:30:00Z"
}

フィールド	型	必須	説明
displayName	string	いいえ	最大長：128
scope	object	いいえ
enabled	boolean	いいえ
expiresAt	string	いいえ	形式：date-time

レスポンス（200）：

APIキーを更新しました

{
	"id": "00000000-0000-0000-0000-000000000000",
	"tenantId": "00000000-0000-0000-0000-000000000000",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"partialKey": "string",
	"enabled": true,
	"createdAt": "2024-03-15T16:30:00Z",
	"lastUsedAt": "2024-03-15T16:30:00Z",
	"expiresAt": "2024-03-15T16:30:00Z",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	}
}

フィールド	型	必須	説明
id	string	はい	形式：uuid
tenantId	string	はい	形式：uuid
organizationId	string	はい	形式：uuid
displayName	string	はい	最大長：128
partialKey	string	はい	最大長：128
enabled	boolean	はい	デフォルト：true
createdAt	string	はい	形式：date-time
lastUsedAt	string	はい	形式：date-time
expiresAt	string	はい	形式：date-time
scope	object	はい

エラー：

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

テナントスコープのAPIキーを削除

組織スコープの書き込みキーが必要です。キーは論理削除され、直ちに認証に使用できなくなります。

エンドポイント： DELETE /v1/tenant/{tenantId}/api-keys/{keyId}

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

パラメーター：

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

レスポンス（200）：

APIキーを削除しました

{
	"message": "string"
}

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

エラー：

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