APIクライアント

APIクライアントとは、同じ組織に所属するユーザーの論理グループのことを指します。

開発、テストおよび本番といった環境ごとにAPIクライアントを設定し、REST APIジョブのAPIにアクセスできるユーザーを関連付けることができます。

APIクライアントでは、Denial of Serviceなどの一般的なタイプのセキュリティ攻撃への対策として、以下の項目を設定します。

APIクライアントの設定は、ナビゲーションメニューの > APIマネジメント > APIクライアントから行います。

ここでは、APIクライアントの作成および設定時のキーポイントについて解説します。

設定のポイント

ここでは、APIクライアントページからの画面遷移と、APIクライアントの作成および編集などの機能について説明します。

= 備考 =

HULFT Squareの基本的なUI要素などの名前と機能については、以下のトピックを参照してください。

APIクライアント

ナビゲーションメニューで > APIマネジメント > APIクライアントを選択すると、このページが表示されます。

APIクライアントの作成、編集、削除など、APIクライアントの管理はここで行います。

(1) APIクライアントを作成

APIクライアントを新規作成するには、このアイコンを選択します。

APIクライアントの設定については、「APIクライアント > 新規追加」を参照してください。

(2) 設定リスト

作成済のAPIクライアントの情報が表形式で表示されます。

(3) アクションメニュー

作成済のAPIクライアントに対して操作を実行するには、このアイコンを選択します。

を選択すると、以下の操作メニューが表示されます。

情報

選択中のAPIクライアントに関する詳細情報が表示されます。APIクライアントの詳細情報の編集および削除もできます。

削除

選択中のAPIクライアントを削除します。

APIクライアント > 新規追加

APIクライアントページでAPIクライアントを作成を選択すると、このページが表示されます。

ウィザード形式のページで、作成するAPIクライアントの情報を順番に設定できます。

APIクライアント > APIクライアント名

APIクライアントページで情報を選択すると、このページが表示されます。

選択中のAPIクライアントに関する詳細情報を確認できます。

(1) APIクライアント名

APIクライアント名に、APIクライアントの名前が表示されます。

(2) メンバー

REST APIにアクセスできるユーザーが表示されます。

(3) IP許可リスト

アクセスを許可したIPアドレスが表示されます。

(4) 編集

APIクライアントの以下の項目を再設定して更新します。

= 備考 =

APIクライアントを更新した場合、REST APIジョブと更新後のAPIクライアントとの紐づけをしなおす必要があります。

この場合は、REST APIジョブの無効化をしてから、再度有効化をしてください。

(5) 削除

APIクライアントを削除します。