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

目次

認可変更 REST API の使用方法

Reauth API コールの使用方法

Reauth API コールのスキーマ ファイル

Reauth API コールの呼び出し

Reauth API コール データ

Disconnect API コールの使用方法

Disconnect API コールのスキーマ ファイル

Disconnect API コールの呼び出し

Disconnect API コール データ

認可変更 REST API の使用方法

認可変更(CoA)コールは、ターゲット モニタリング ノードの指定されたセッションにコマンドを送信して次を実行します。

セッション再認証(Reauth API コールを使用)

セッション切断(Disconnect API コールを使用)。

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

「Reauth API コールの使用方法」

「Disconnect API コールの使用方法」

Reauth API コールの使用方法

Reauth API コールは、指定されたセッションに再認証コマンドを送信します。各セッションは、関連づけられている値があり、次のいずれかになります。

0:REAUTH_TYPE_DEFAULT

1:REAUTH_TYPE_LAST

2:REAUTH_TYPE_RERUN

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 コールの呼び出し


) ターゲット ノードが、有効なモニタリング ノードであることを確認している必要があります。ノードのペルソナを確認するには、「モニタリング ノードの確認」 を参照してください。



ステップ 1 ターゲット モニタリング ノードにログインします。

たとえば、ホスト名が acme123 のモニタリング ノードに最初にログインすると、次の URL アドレス フィールドが表示されます。

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

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

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

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


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


 

Reauth API コール データ

Reauth API コールは次のいずれかの結果を返します。

「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>

Disconnect API コールの使用方法

Disconnect API コールは、指定されたセッションに切断コマンドを送信します。各ポートは、関連づけられている値があり、次のいずれかになります。

0:DYNAMIC_AUTHZ_PORT_DEFAULT

1:DYNAMIC_AUTHZ_PORT_BOUNCE

2:DYNAMIC_AUTHZ_PORT_SHUTDOWN

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 コールを発行するターゲット ノードが、有効なモニタリング ノードであることを確認します。ノードのペルソナを確認するには、「モニタリング ノードの確認」 を参照してください。



ステップ 1 ターゲット モニタリング ノードにログインします。

たとえば、ホスト名が acme123 のモニタリング ノードに最初にログインすると、次の URL アドレス フィールドが表示されます。

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

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

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

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


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


 

Disconnect API コール データ

Disconnect API コールは次のいずれかの結果を返します。

「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>