Trend Cloud Oneでのリクエストの認証に使用するAPIキーを作成できます。 Trend Cloud OneへのAPIアクセスが必要なユーザごとに1つのAPIキーを作成する必要があります。
1つのAPIキーで、アカウント内のすべてのTrend Cloud Oneサービスにアクセスできます。
APIキーが作成されると、APIキーに関連付けられた一意の秘密キーが提供されます。この秘密鍵は、認証用のAPI呼び出しで使用します。
新しいAPIキーを作成する
手順
- Trend Cloud Oneコンソールの右上で、APIキーを追加するアカウントを選択します。
- アカウント名をクリックします。
- [管理]を選択してください。
- 左側の鍵のアイコンをクリックして、[APIキー] を表示します。
- [新規]をクリックしてください。
- [新しいAPIキー] ダイアログで、次のように入力します。
- [APIキーのエイリアス] フィールドに、APIキーのわかりやすい名前を指定します。
- [説明] フィールドに、APIキーの詳細な説明を入力します。
- [役割] フィールドで、ユーザ role を割り当てて、Trend Cloud Oneの各種サービスへのAPIキーアクセスの範囲を決定します。
- [ [言語] ] フィールドで、[英語] または [日本語] を選択します。
- [タイムゾーン] フィールドに、APIキーのユーザがいる場所のタイムゾーンを指定します。
- 必要に応じて、[Provide ability to add multiple IP / CIDR ranges here] フィールドを使用して、このAPIキーに適用するIPおよびCIDR範囲のリストを定義します。定義されている場合は、リストされたIPとCIDRからのリクエストのみがTrend Cloud Oneサービスで許可されます。
- [次へ]をクリックしてください。
- 表示されたAPIキーの値をコピーしてコンピュータに保存します。キーを紛失した場合は、新しいキーを作成する必要があります。
- [閉じる]をクリックしてください。キーの作成後、このページの [APIキーのプロパティ] セクションを使用して、APIキーのプロパティを変更できます。
APIキーのロックアウト
既存のAPIキーが不正使用された場合は、次の手順に従ってロックアウトできます。
手順
- ロックアウトするAPIキーを選択します。
- [APIキーのプロパティ]セクションで、[有効化済み]を[×]に設定します。
- [保存]をクリックしてください。APIキーを選択して[削除]をクリックすると、APIキーを完全に削除できます。
Cloud One APIキーを使用したリクエストの実行
要求ごとに、ヘッダの認証が必要です。Cloud One APIキーの場合:
- ヘッダ:
- キー:
Authorization
- 値:
ApiKey <your_key_value>
- キー:
一部のサービスのAPIには、
Api-Version
ヘッダも必要です。詳細については、各サービスのAPIリファレンスドキュメントを参照してください。グローバルURLを持つAPIもあれば、アカウントのリージョンを指定する必要があるAPIもあります。アカウントと同じリージョンのAPIキーを使用し、APIキーに正しいリージョンを指定してください。現在利用可能なリージョンのリストについては、Trend Cloud Oneのリージョンを参照してください。
次に、グローバルエンドポイントのcurlコマンドの例を示します。
curl -X GET https://accounts.cloudone.trendmicro.com/api/accounts/<your-account-id>
-H 'Authorization: ApiKey <your-key-value>' -H 'api-version: v1'
次に、リージョンエンドポイントのcurlコマンドの例を示します。
curl -X GET https://audit.us-1.cloudone.trendmicro.com/api/logs -H 'Authorization:
ApiKey <your-key-value>' -H 'api-version: v1'