[FMC] REST API の動作を確認する方法 with Postman - 認証トークンの生成

[sisozumi]

• 1. 本記事の概要
• 2. FMC REST API の 有効化
• 3. REST API トークン認証
• 3.1. トークン認証とは
• 3.2. トークン認証の注意点
• 3.3. トークン認証の手順

 

1. 本記事の概要

本ドキュメントでは、Postmanを使用して FMC ( Firepower Management Center ) の REST API を使用するための認証方法である、

トークン認証のためのトークンの生成方法と、その認証が動作することを確認する手順を説明します。

本ドキュメントでの動作は、以下の環境で実施しています。

 ・ Firepower Management Center Virtual 6.6.1

 ・ Postman v8.0.10 (for Windows 64 bit)

Postmanのダウンロード、その他FirepowerのREST APIの機能に関しては、

下記ドキュメントもご参照ください。

Download Postman

【Top Out Human Capital 共催】Community Live : WebベースAPI基礎とPostmanの使い方 

      ※ 本ドキュメントは 2021/03/30 現在の情報を元に作成しております。

2. FMC REST API の 有効化

FMC REST APIは、FMC上で有効化する必要があります。

デフォルトで有効化されていますが、手動で有効にする必要がある場合、

下記手順に従って確認・有効化してください。

1. FMC へHTTPS接続

2. 歯車マーク > Configuration へ移動

3. 左部メニューから、[REST API Preference] を選択

4. Enable REST APIにチェックマークが入っているか確認

3. REST API トークン認証

 

3.1. トークン認証とは

REST APIでは、HTTPメソッドが使用されます。FMC REST APIでは

リクエスト送信のために使用される認証方法がトークン認証となります。

FMC REST API の認証トークンは2種類あり、それぞれ下記のKEYとなります。

1. X-auth-access-token : アクセストークン。FMC REST API に送信するすべてのリクエストに必要

2. X-auth-refresh-token : リフレッシュトークン。認証トークンを更新する場合に、アクセストークンと組み合わせて使用

FMC REST API の認証トークンは30分間有効であり、最大で3回更新することができます。

      アクセストークンの期限が切れた場合に、リフレッシュトークンを利用して更新することができます。

3.2. トークン認証の注意点

APIのインターフェースとFirepowerユーザインターフェースで

同じアカウントを同時使用すると、警告なしにログアウトされるため、

異なるアカウントを使用するようご注意ください。

そのため、GUIとAPI両方で動作を確認する場合は、

FMC上で異なるユーザーを作成することを推奨します。

また、REST APIに初めて接続する際は、

無効な証明書により接続が安全ではないというエラーが表示される場合があります。

証明書を使用して接続を許可するように、ブラウザに例外を追加してください。

3.3. トークン認証の手順

前章に従って、FMCでRESR APIが有効化されているかを確認してください。

1. Postman を起動
2. [My Workspace] から、[New] を選択
3. [Create New] ウインドウの [Building Blocks] より、[Request] を選択

    4. [Request name] に適当な名称 (FMC Token等) を入力

    5. [+ Create Collection] を選択し、新たにコレクションを作成

    6. コレクション名を入力し、それを選択するか、既存のコレクションを選択

    7. 右下の [Save to ...] で保存

    8. 保存したコレクションの [Authorization] タブから、[Type] メニューより [Basic Auth] を選択

    9. Username と Password を入力し、[Save] を選択後、[Send] を選択

  10. 下部のHeadersに2種類のトークンが表示されていることを確認してください

これで トークンによる認証が動作したことが確認できます。