REST APIキーの使用
6 min
テナント用に作成された REST API キーは、REST API エンドポイントの承認に使用されます。 これらのキーは静的であり、セッション ID とは異なり、変更されたり期限切れになったりすることはありません。
REST API キーグループの作成
この機能を初めて使用する場合、REST API のグループを作成する必要があります。 すでに存在する場合は、この手順をスキップして、 REST API キーの作成に進むことができます。
- 構成コンソールから、[ 構成 ] > [ セキュリティ コントロール ] > [ API キー] を選択します。
- キーグループの追加をクリックします。 アプリケーションは、「 新しい API グループ 」ページを表示します。
- 名前 および 説明 フィールドに、グループのコンテキスト名と説明を入力します。
- キー グループの保存をクリックします。 REST API グループが作成されます。
- 「 戻る 」をクリックして、「 API キー 」ページに戻ります。
REST API キーの作成
- 構成コンソールから、[ 構成 ] > [ セキュリティ コントロール ] > [ API キー] を選択します。
- キー グループ セクションから、REST API 用に作成された関連グループを選択します。
REST API グループ

- API キーの追加をクリックします。 アプリケーションは、「 新しい API キー 」ページを表示します。
- フィールドに情報を入力します:
- 参照 ID - このフィールドは自動生成されます。 この ID は、エンドポイント認証に使用する必要がある REST API キーです。
- アクティブ化 - キーをアクティブ化または非アクティブ化するには、チェックボックスを選択または選択解除します。
- 説明 - キーの説明を入力します。
- 代理 - キーを作成するユーザーの名前を選択します。
- ロール - キーを作成するユーザーのロールを選択します。
- デフォルトでは、作成された REST API キーはログインしたテナントに適用されます。 ただし、このキーに追加の IP を追加できます。 これを行うには、「 新しい IP の追加」をクリックし、IP アドレスを入力して、「 OK」をクリックします。
- キーを保存をクリックします。 生成された REST API キーは、入力した詳細とともに保存されます。
- 「 戻る 」をクリックして、「 API キー 」ページに戻ります。
REST API キーの編集
- 構成コンソールから、[ 構成 ] > [ セキュリティ コントロール ] > [ API キー] を選択します。
- キー グループ セクションから REST API の関連グループを選択します。 アプリケーションは使用可能なキーのリストを表示します。
- キーを見つけて、[ 編集] をクリックします。
- 必要に応じて詳細を変更し、「 キーを保存」をクリックします。
REST API キーの削除
- 構成コンソールから、[ 構成 ] > [ セキュリティ コントロール ] > [ API キー] を選択します。
- キー グループ セクションから REST API の関連グループを選択します。 アプリケーションは使用可能なキーのリストを表示します。
- キーを見つけて、[ 削除] をクリックします。
REST APIキーの使用
エンドポイントを実行するときに REST API キーを認証として使用するには:
- Postman アプリケーションで新しいリクエストを作成します。
- ヘッダー タブに次の情報を入力します。
- 認証 チェックボックスをオンにします。
- テナントに対して生成された参照 ID (REST API キー) を、 値 列に、 restapikey={参照 ID}の形式で入力します。
- 同じエンドポイント要求ウィンドウで、エンドポイント要求ペイロードの詳細を入力し、「 送信 」ボタンをクリックするか、ENTER キーを押します。
テナントから REST API を実行する場合、同じテナントに対して生成された REST API キーのみ使用でき、他のテナントの REST API キーは使用できません。 たとえば、テナント用に生成されたREST APIキー
REST API キーのトラブルシューティング
REST API エンドポイントを実行すると、権限がないというエラーが発生します。
理由:
エンドポイントを承認するために使用される REST API キーは、このテナント/IP に属していません。
解決:
このテナント/IP の新しい REST API キーを作成します。 REST API キーの作成を参照してください。
