Cisco Identity Services Engine Release 1.1.x API リファレンス ガイド
認可変更 REST API の使用
認可変更 REST API の使用
発行日;2012/09/25 | 英語版ドキュメント(2012/03/30 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 1MB) | フィードバック

目次

認可変更 REST API の使用

CoA セッション管理 API コールの使用

セッション再認証 API コール

Reauth API の出力スキーマ

Reauth API コールの呼び出し

Reauth API コールから返されるサンプル データ

セッション切断 API コール

Disconnect API の出力スキーマ

Disconnect API コールの呼び出し

Disconnect API コールから返されるサンプル データ

認可変更 REST API の使用

この章では、Cisco Identity Services Engine のこのリリースでサポートされている次の個々の認可変更(CoA)REST API コールの使用法について例をあげながら説明します。CoA API コールは、Cisco ISE 導入で指定された Cisco Monitoring ISE ノードセッションに認証コマンドおよびセッション切断コマンドを送信する方法を提供します。

次の項では、API の出力スキーマ ファイルの例、各 API コール発行の手順、および各 API コールによって返されるデータのサンプルについて説明します。

「セッション再認証 API コール」

「セッション切断 API コール」

CoA セッション管理 API コールの使用

CoA セッション管理 API コールにより、Cisco ISE 導入において、ターゲット Cisco Monitoring ISE ノードの指定セッションに再認証コマンドおよび切断コマンドを送信できるようにします。

セッション再認証(Reauth)

セッション切断(Disconnect)

セッション再認証 API コール

ここでは、スキーマ ファイルの出力例、Reauth API コールを呼び出すことにより、セッション再認証コマンドおよび Reauth タイプを送信する手順、この API コール発行後に返されるデータのサンプルについて説明します。再認証のタイプには次のいずれかを割り当てることができます。

REAUTH_TYPE_DEFAULT = 0

REAUTH_TYPE_LAST = 1

REAUTH_TYPE_RERUN = 2

Reauth API の出力スキーマ

このサンプル スキーマ ファイルは、ターゲット Cisco Monitoring ISE ノードで指定セッションへの送信後の Reauth API コールの出力です。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="remoteCoA" type="coAResult"/>
<xs:complexType name="coAResult">
<xs:sequence>
<xs:element name="results" type="xs:boolean" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="requestType" type="xs:string"/>
</xs:complexType>
</xs:schema>

Reauth API コールの呼び出し


) API コールを発行するターゲット ノードが、有効な Cisco Monitoring ISE ノードであることを確認している必要があります。Cisco ISE ノードのペルソナを確認するには、「Cisco Monitoring ISE ノードの確認」を参照してください。


Reauth API コールを発行するには、次の手順を実行します。


ステップ 1 ターゲット Cisco Monitoring ISE ノードにログインします。

たとえば、ホスト名が acme123 の Cisco Monitoring ISE ノードに最初にログインする場合、このノードの URL アドレスが次のように表示されます。

https://acme123/admin/LoginAction.do#pageId=com_cisco_xmp_web_page_tmpdash
 

ステップ 2 「/admin/」コンポーネントを API コールのコンポーネント(/ise/mnt/api/CoA/<specific-api-call>/<macaddress>/ <reauthtype>/<nasipaddress>/<destinationipaddress>)に置き換えて、ターゲット ノードの URL アドレス フィールドに Reauth API コールを入力します。

https://acme123/ise/mnt/api/CoA/Reauth/server12/00:26:82:7B:D2:51/2/10.10.10.10

) これらのコールは、大文字小文字を区別するため、ターゲット ノードの URL アドレス フィールドに慎重に各 API コールを入力する必要があります。API コール規則での「mnt」の使用は、Cisco Monitoring ISE ノードを表します。


ステップ 3 Enter キーを押して API コールを発行します。


 

Reauth API コールから返されるサンプル データ

次に、ターゲット Cisco Monitoring ISE ノードで Reauth API コールを呼び出すときに返されるデータを示します。このコマンドの呼び出しから、次の 2 種類の結果が返されます。

「True」はコマンドが正常に実行されたことを示します。

「False」は(さまざまな条件により)コマンドが実行されなかったことを意味します。

This XML file does not appear to have any style information associated with it. The document tree is shown below.
 
-
<remoteCoA requestType="reauth">
<results>true</results>
</remoteCoA>

セッション切断 API コール

ここでは、スキーマ ファイルの出力例、Disconnect API コールを呼び出すことにより、セッション接続解除コマンドおよびポート オプション タイプを送信する手順、この API コール発行後に返されるデータのサンプルについて説明します。接続解除のポート オプション タイプには、次のいずれかを割り当てることができます。

DYNAMIC_AUTHZ_PORT_DEFAULT = 0

DYNAMIC_AUTHZ_PORT_BOUNCE = 1

DYNAMIC_AUTHZ_PORT_SHUTDOWN = 2

Disconnect API の出力スキーマ

このサンプル スキーマ ファイルは、ターゲット Cisco Monitoring ISE ノードで指定セッションへの送信後の Disconnect API コールの出力です。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
 
<xs:element name="remoteCoA" type="coAResult"/>
 
<xs:complexType name="coAResult">
<xs:sequence>
<xs:element name="results" type="xs:boolean" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="requestType" type="xs:string"/>
</xs:complexType>
</xs:schema>

Disconnect API コールの呼び出し


) API コールを発行するターゲット ノードが、有効な Cisco Monitoring ISE ノードであることを確認している必要があります。Cisco ISE ノードのペルソナを確認するには、「Cisco Monitoring ISE ノードの確認」を参照してください。


Disconnect API コールを発行するには、次の手順を実行します。


ステップ 1 ターゲット Cisco Monitoring ISE ノードにログインします。

たとえば、ホスト名が acme123 の Cisco Monitoring ISE ノードに最初にログインする場合、このノードの URL アドレスが次のように表示されます。

https://acme123/admin/LoginAction.do#pageId=com_cisco_xmp_web_page_tmpdash
 

ステップ 2 「/admin/」コンポーネントを API コールのコンポーネント(/ise/mnt/api/CoA/<Disconnect>/<serverhostname>/ <macaddress>/<portoptiontype>/<nasipaddress>/<destinationipaddress>)に置き換えて、ターゲット ノードの URL アドレス フィールドに Disconnect API コールを入力します。

https://acme123/ise/mnt/api/CoA/Disconnect/server12/
00:26:82:7B:D2:51/2/10.10.10.10

) これらのコールは、大文字小文字を区別するため、ターゲット ノードの URL アドレス フィールドに慎重に各 API コールを入力する必要があります。API コール規則での「mnt」の使用は、Cisco Monitoring ISE ノードを表します。


ステップ 3 Enter キーを押して API コールを発行します。


 

Disconnect API コールから返されるサンプル データ

次に、ターゲット Cisco Monitoring ISE ノードで Disconnect API コールを呼び出すときに返されるデータを示します。このコマンドの呼び出しから、次の 2 種類の結果が返されます。

「True」はコマンドが正常に実行されたことを示します。

「False」は(さまざまな条件により)コマンドが実行されなかったことを意味します。

This XML file does not appear to have any style information associated with it. The document tree is shown below.
 
-
<remoteCoA requestType="reauth">
<results>true</results>
</remoteCoA>