クライアントとの接続

REST API クライアントを使用して REST API にアクセスできます。通常、REST API クライアントはブラウザのプラグインとして使用できますが、任意の REST API クライアントを使用できます。


(注)  


REST API に初めて接続すると、証明書の警告が表示されます。REST API を使用するためには証明書を受け入れる必要があります。


REST API クライアントからの認証

API とのインターフェイスとユーザーインターフェイスには、異なるアカウントを使用することをお勧めします。資格情報は、両方のインターフェイスで同時には使用できません。同時使用すると警告なしにログアウトされます。

REST API に初めて接続する際は、無効な証明書により接続が安全ではないというエラーが表示される場合があります。証明書を使用して接続を許可するように、ブラウザに例外を追加します。

トークン ベース認証では、ユーザ名とパスワードを指定することによってトークンを取得します。要求ごとにユーザ名とパスワードを必要とせずに、限られた期間だけ HTTP サービスにアクセスするには、このトークンを使用します。つまり、要求ごとにユーザ名とパスワードで認証しなくても済むように、ユーザ資格情報を一意に生成されたアクセス トークンで置き換えます。これを使用すると最長 30 分間リソースにアクセスでき、3 回まで更新できます。

次の図に、トークンベースの認証の概念を示します。

認証トークンの要求

トークン生成ユーティリティは、REST API クライアントで使用できる認証トークンを提供します。

始める前に

設定済みの Management Center と、REST API を使用するための資格情報を持つアカウントが必要です。基本認証を実行できる REST API クライアントも必要です。

手順


ステップ 1

REST API クライアントを開きます。

ステップ 2

https://<management_center_IP_or_name>/api/fmc_platform/v1/auth/generatetoken の URL に POST コマンドを行うようクライアントを設定します。

ステップ 3

ユーザー名とパスワードを基本認証ヘッダーとして含めます。POST 本文は空白にする必要があります。


次のタスク

API への要求に、ヘッダー X-auth-access-token:<authentication token value> を追加します。

REST API クライアントからの認証 に記載されているように、要求にヘッダー X-auth-access-token:<authentication token value> および X-auth-refresh-token:<refresh token value> を追加して、トークンを更新します。

サーバーへのすべての REST 要求に認証トークンからの Domain_UUID を使用します。

認証トークンの更新

Management Center REST API 認証トークンは 30 分間有効で、3 回まで更新することができます。

始める前に

Management Center REST API から有効な認証と更新のトークンを取得します。これらのトークンの更新が 3 回未満であることを確認します。

手順


ステップ 1

REST API クライアントを開きます。

ステップ 2

X-auth-access-token:<authentication token value> および X-auth-refresh-token:<refresh token value> ヘッダーを使用して、https://<management_center_IP_or_name>/api/fmc_platform/v1/auth/refreshtoken の URL に POST コマンドを行うようクライアントを設定します。


次のタスク

API への要求に、ヘッダー X-auth-access-token:<new authentication token value> を追加します。

要求に、ヘッダー X-auth-refresh-token:<new refresh token value> を追加して、トークンを更新します。