APIキー

ProcessMindでのAPIキー管理

ProcessMindのAPIと連携するには、APIキーを作成して管理する必要があります。APIキーの生成、使用、保護の方法を説明します。

ProcessMindアカウントの設定で、「API Keys」セクションに移動します。ここで、新しい環境APIキーボタンをクリックして新しいAPIキーを作成できます。後から識別できるよう、キーに名前を付けてください。

APIキーの作成

複数のアプリケーションやサービス用に、複数のAPIキーを作成できます。各キーは個別に管理できるため、他の連携に影響を与えず、必要に応じてキーを無効化できます。 キーを生成したら、安全な場所にコピーして保管してください。セキュリティ上の理由から、キーが表示されるのは作成時の1回だけです。

組織のAPIキー

組織の管理者は、同じページで組織のAPIキーも作成できます。環境キーとは異なり、組織キーは組織内のすべての環境（テナント）で使用できるため、1つの連携ですべての環境に対応できます。組織キーでは、次の操作を行えます。

• 環境APIキーを用意します：/v1/tenant/{tenantId}/api-keys外部API を通じて、テナント単位のキーを作成、更新、削除します。- 1回限りのログインリンクを発行します：独自の製品からProcessMindへ、認証済みの状態でユーザーを直接移動させます（/v1/tenant/{tenantId}/users/{userId}/login-token）。

スコープ

スコープ	付与される権限
read	テナントデータの読み取り（一覧取得／取得エンドポイント）。デフォルトで有効です。
write	テナントデータの作成、更新、削除。デフォルトで有効です。
uploadData	データテーブル用の署名付きアップロードURLをリクエストします。デフォルトで有効です。
sessions	1回限りのログイン引き継ぎトークンを発行します。デフォルトでは無効です。

sessionsは、ログイン引き継ぎが必要なキーにのみ有効にしてください。発行されたトークンを使うとパスワード入力なしでユーザーをログインさせられるため、パスワードと同じように扱う必要があります。組織キーでは組織内のすべての環境のユーザーに対して発行できますが、環境キーではその環境のユーザーにのみ発行できます。

1回限りのログイン引き継ぎ

POST /v1/tenant/{tenantId}/users/{userId}/login-tokenは、ユーザー、環境、組織に紐付いた、1回だけ使用できるトークン（有効期間60秒）とurlを返します。ユーザーのブラウザーをそのURLへ移動させると、ユーザー自身のセッションでProcessMindが開きます。メールリンクやなりすましは必要ありません。リクエスト本文にpathを任意で指定すると、特定のページへ直接移動できます。キーにはsessionsスコープが必要です。また、発行できるユーザーは、キーが使用を許可されているテナントのユーザーに限られます。

発行操作は監査対象となり、厳格なレート制限が適用されます。キーが無効化された場合や、ユーザーがアクセス権を失った場合は、直ちにブロックされます。トークンは1回だけ返され、ログには記録されません。

関連トピック

• API概要：API呼び出しの方法です。
• APIリファレンス：エンドポイントのドキュメントです。