このページの内容

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

テナント情報を取得

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

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

パラメーター：

名前	型	場所	必須	説明
tenantId	string	path	はい	形式：`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
	},
	"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`

エラー：

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

テナント設定を更新

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

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

パラメーター：

名前	型	場所	必須	説明
tenantId	string	path	はい	形式：`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
	},
	"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値を受け付けられません（予約済みまたは重複した短縮名など）

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

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

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

パラメーター：

名前	型	場所	必須	説明
tenantId	string	path	はい	形式：`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	はい

エラー：

401APIキーがない、無効、停止中、または有効期限切れ
404リソースが見つかりません

テナント内のユーザー一覧を取得

条件に一致するユーザーをJSON配列で返します。合計件数は返されません。limit/offsetを使ってページを指定してください。

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

エラー：

401APIキーがない、無効、停止中、または有効期限切れ

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

リクエスト本文のロール関連フィールド（isAdminInTenant、access: none|portalViewer|designer|architect|intelligence、isDashboardViewer）は、指定された値のまま反映されます。このエンドポイントではテナント管理者向けのすべての操作が可能なため、書き込みスコープのキーは信頼できる呼び出し元にのみ発行してください。ダッシュボードの閲覧権限はisDashboardViewerの真偽値で指定します。従来の読み取り専用ビューアー権限は廃止されています。

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

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

パラメーター：

名前	型	場所	必須	説明
tenantId	string	path	はい	形式：`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`	いいえ	シートを1つ選択：なし \| portalViewer \| designer \| architect \| intelligence 許可される値：`none`、`portalViewer`、`designer`、`architect`、`intelligence`
isDashboardViewer	boolean	いいえ	ユーザーが読み取り専用のダッシュボードを表示できるかどうか
preferredLocale	`en` \| `zh` \| `es` \| `fr` \| `de` \| `pt` \| `it` \| `nl` \| `ja` \| `tr` \| `pl` \| `cs` \| `hu` \| `id` \| `ko` \| `vi` \| `th`	いいえ	ユーザーの優先UI言語許可される値：`en`、`zh`、`es`、`fr`、`de`、`pt`、`it`、`nl`、`ja`、`tr`、`pl`、`cs`、`hu`、`id`、`ko`、`vi`、`th`

レスポンス（201）：

ユーザーを追加しました

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

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

エラー：

401APIキーがない、無効、停止中、または有効期限切れ
409現在の状態とリクエストが競合しています（シートの制限、IDの重複使用など）

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

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

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

パラメーター：

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

リクエスト本文：

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

フィールド	型	必須	説明
isActiveInTenant	boolean	いいえ	このテナントでユーザーがアクティブかどうか
isAdminInTenant	boolean	いいえ	このテナントでの管理者権限（指定された値のまま反映：テナント管理者向けのすべての操作が可能）
access	`none` \| `portalViewer` \| `designer` \| `architect` \| `intelligence`	いいえ	1つのシートを選択：none \| portalViewer \| designer \| architect \| intelligence。ダッシュボードの閲覧権限はisDashboardViewerの真偽値で指定します。指定可能な値：`none`、`portalViewer`、`designer`、`architect`、`intelligence`
isDashboardViewer	boolean	いいえ	ユーザーにダッシュボードの読み取り専用閲覧権限があるかどうか

レスポンス（200）：

更新しました

{
	"message": "string"
}

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

エラー：

400不正なフィルター式、モデルのないプロセス、未対応のアップロード形式、必須項目の不足などによる不正なリクエスト
401APIキーがない、無効、停止中、または有効期限切れ
404リソースが見つかりません

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

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

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

パラメーター：

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

レスポンス（200）：

ユーザーを削除しました

{
	"message": "string"
}

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

エラー：

400不正なフィルター式、モデルのないプロセス、未対応のアップロード形式、必須項目の不足などによる不正なリクエスト
401APIキーがない、無効、停止中、または有効期限切れ
404リソースが見つかりません

ユーザー用の1回限りのログイン引き継ぎトークンを発行

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

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

**認証：**テナントまたは組織スコープのAPIキー・sessionsスコープ・レート制限：毎秒2リクエスト（バースト時4リクエスト）

パラメーター：

名前	型	場所	必須	説明
tenantId	string	path	はい	形式：`uuid`
userId	string	path	はい	形式：`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不正なフィルター式、モデルのないプロセス、未対応のアップロード形式、必須項目の不足などによる不正なリクエスト
401APIキーがない、無効、停止中、または有効期限切れ
403APIキーに必要なスコープまたは組織へのアクセス権がない、テナントが非アクティブ、またはプランでファイル形式が制限されている
404リソースが見つかりません
429レート制限に達しました。エンドポイントに記載されたレート制限をご確認ください

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

テナントのAPIキー一覧を取得

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

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

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

パラメーター：

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

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

エラー：

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

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

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

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

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

パラメーター：

名前	型	場所	必須	説明
tenantId	string	path	はい	形式：`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不正なフィルター式、モデルのないプロセス、未対応のアップロード形式、必須項目の不足などによる不正なリクエスト
401APIキーがない、無効、停止中、または有効期限切れ
403APIキーに必要なスコープまたは組織へのアクセス権がない、テナントが非アクティブ、またはプランでファイル形式が制限されている

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

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

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

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

パラメーター：

名前	型	場所	必須	説明
tenantId	string	path	はい	形式：`uuid`
keyId	string	path	はい	形式：`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不正なフィルター式、モデルのないプロセス、未対応のアップロード形式、必須項目の不足などによる不正なリクエスト
401APIキーがない、無効、停止中、または有効期限切れ
403APIキーに必要なスコープまたは組織へのアクセス権がない、テナントが非アクティブ、またはプランでファイル形式が制限されている
404リソースが見つかりません

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

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

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

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

パラメーター：

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

レスポンス（200）：

APIキーを削除しました

{
	"message": "string"
}

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

エラー：

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

プロセスをより良く設計し、つながりのあるアーキテクチャを構築して、管理を続けましょう。

クレジットカード不要、待ち時間なしですぐにご利用いただけます。組織の業務の進め方を、明確につながるプロセス設計として可視化します。

プロセスアーキテクチャを構築し、オーナーシップと統制を定め、あらゆる階層で役割と責任を明確にします。

無料トライアルを開始して、プロセスのガバナンス、管理、継続的な改善を支える信頼できる基盤を築きましょう。

無料トライアルを開始

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

テナント情報を取得

テナント設定を更新

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

テナント内のユーザー一覧を取得

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

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

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

ユーザー用の1回限りのログイン引き継ぎトークンを発行

テナントのAPIキー一覧を取得

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

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

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

関連文書

APIリファレンス：組織

APIリファレンス：データ

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

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

プロセスをより良く設計し、つながりのあるアーキテクチャを構築して、管理を続けましょう。