API キー管理

API キー管理は、Docwize API へのリクエストを認証するために使用する Bearer トークンをユーザーが生成・管理する機能です。各キーはシステムの特定領域にスコープを設定でき、削除することなく無効化することも、後でスコープを再設定することもできます。

アクセス: New > API KEY MANAGEMENT > API Key Management

API キーマネージャーの一覧

概要

API キーマネージャーには、組織向けに作成されたすべてのキーが一覧表示されます。各カードには以下が表示されます。

フィールド	説明
Name	キーを作成したときに付けたラベルです。
Created Date	キーが生成された日付です。
Expiry Date	キーが失効する日付です。失効が近いキーには Almost Expired のフラグが表示されます。
Token Type	トークンの種別です（例：User-scoped）。
Scope	このキーがアクセスを許可する権限領域です（詳細は下記の「スコープの編集」を参照してください）。
Enable/disable toggle	キーを削除することなく、有効・無効を切り替えます。
Edit Scopes	このキーのスコープピッカーを開きます。キーが有効な場合のみ使用できます。

有効なキーの Edit Scopes をクリックすると、スコープピッカーが開きます。

Edit API Key Scopes ダイアログ

キーには一度に1つ以上のスコープを設定できます。利用可能なスコープ：

スコープを選択または削除し、Save をクリックして変更を適用するか、Cancel をクリックして変更を破棄します。

問題	詳細
Edit Scopes がグレーアウトしている	キーが現在無効になっています。トグルをオンにしてキーを再度有効にすると、スコープを編集できるようになります。
キーに Almost Expired と表示される	キーの有効期限が近づいています。このキーを使用したリクエストは、有効期限が切れると認証されなくなります。