1.1 前提知識

APIを実行するために事前にAPI認証作業を行う必要があります。

(1)Ops Iトークンの取得

Pre-Installedロール「System Security Administrator」を付与されているシステム管理者が、任意のユーザーに対して、Ops Iトークンを発行することができます。Ops Iトークンに有効期限はありません。

Ops Iトークンを取得するには、システム管理/ユーザー管理/ユーザー/ユーザー詳細画面の関連するリソースエリアのトークンタブにある「トークン発行」ボタンをクリックします。ダイアログに発行されたOps Iトークンが表示されるので、システム管理者はメモなどで保存してください。発行されたOps Iトークンは別の画面に遷移すると確認することができなくなります。

Ops Iトークンの取得状況は、トークンタブから確認することができます。Ops Iトークンを発行済みのユーザーの場合は、トークンタブにトークン発行日時が表示されます。

また、Ops Iトークンを発行済みのユーザーの場合は、トークンタブに「トークン破棄」ボタンが表示されます。Ops Iトークンが不要になった場合、システム管理者は「トークン破棄」ボタンをクリックし、表示された「トークンの破棄」ダイアログで「OK」ボタンをクリックすることで、Ops Iトークンを破棄することができます。


(2)Ops Iトークンの提供・設定

システム管理者は取得したOps Iトークンを、APIを実行するユーザーにメールなどで提供します。
APIを実行するユーザーは、Ops Iトークンをヘッダーとして設定することで、APIを実行することができます。
また、「(3)Ops Iアクセストークンの取得(非推奨)」で取得したOps Iアクセストークンをヘッダーとして設定し、APIを実行することも可能です。(非推奨)

<実行例> Ops Iトークンをヘッダーとして設定する場合

# curl -XGET "Ops IのURL/api/v1/gitops-logs" ¥
-H "X-OpsI-Token: Ops Iトークン"

<実行例> Ops Iアクセストークンをヘッダーとして設定する場合

# curl -XGET "Ops IのURL/api/v1/gitops-logs" ¥
-H "Authorization: Bearer Ops Iアクセストークン"



(3)Ops Iアクセストークンの取得(非推奨)

APIを実行するユーザーは、API「refresh-token」により、Ops Iアクセストークンを取得できます。その際、「(2)Ops Iトークンの提供・設定」で提供されたOps Iトークンをヘッダーとして設定する必要があります。Ops Iアクセストークンの有効期限は30分です。実行例を以下に示します。

<実行例> /oauth2/refresh-token

# curl -XPOST "Ops IのURL/oauth2/refresh-token" ¥
-H "X-OpsI-Token: Ops Iトークン"


API「refresh-token」で取得したレスポンスボディ(JSON形式)のaccess_tokenの値を、Ops Iアクセストークンとしてヘッダーに設定することでAPI「refresh-token」以外のAPIを実行できます。