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トークン発行確認画面

(図)Ops Iトークン発行確認画面 (図)Ops Iトークン発行確認画面

システム管理者はOps Iトークンの取得状況をユーザーのプロフィール画面で確認することができます。

(図)Ops Iトークン確認画面

(図)Ops Iトークン確認画面 (図)Ops Iトークン確認画面

Ops Iトークンを付与したユーザーのプロフィール画面には「トークン破棄」ボタンが表示されます。Ops Iトークンが不要になった場合、「トークン破棄」ボタンをクリックすると認証を取り消すことができます。

(図)Ops Iトークン取消画面

(図)Ops Iトークン取消画面 (図)Ops Iトークン取消画面

ダイアログ「トークンの破棄」が表示されます。システム管理者はOps Iトークンの認証または取り消しを確定することができます。

(図)Ops Iトークン取消確認画面

(図)Ops Iトークン取消確認画面 (図)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を実行できます。