Web サービス API - XML-RPC の使用
(Premium Edition および Enterprise Edition でのみ利用可能な機能)

XML-RPC は、プロシージャ呼び出しのエンコーディングとして XML を使用し、HTTP/HTTPS 経由でリモート プロシージャ呼び出しを実行するための仕様です。オープンで軽量、シンプルで実装が簡単です。

メソッド: メソッドのリスト

1.メソッドの詳細

pmp.resources.create

これにより、Password Management Pro リポジトリにすべての詳細を含むリソースが作成されます。

URL: https://pmp-server:7070/xmlrpc


2.要求パラメータ

名前 種類 必要性 説明

resourceName

String

はい

PMP 内のリソースの一意の名前。

resourceType

String

はい

リソースの種類。

accountName

String

はい

リソースのユーザーアカウント名。

newPassword

String

オプション

ユーザーアカウントのパスワード。

notes

String

はい

ユーザーアカウントに関するメモ。

要求パラメータ

名前 説明 値

resultCode

要求されたメソッド呼び出しの結果を説明する数値。

0 - Success
All other values - Failure with reason in the message parameter.

message

resultCode に基づいて、操作の結果の理由を説明するテキスト。

"SUCCESS" on Success
[<Message>] on other failure cases

要求 XML の例

<?xml version="1.0" encoding="utf-8"?> <methodCall> <methodName>pmp.resource.create</methodName> <params> <param> <value><string>pmp-server<>string></value> </param> <param> <value><string>Windows</string></value> </param> <param> <value><string>administrator</string></value> </param> <param> <value><string>SMP</string></value> </param> <param> <value><string>Admin user</string></value> </param> </params> </methodCall>

応答 XML の例

成功

<?xml version="1.0" encoding="utf-8"?> <methodResponse> <params> <param> <value> <struct> <member> <name>resultCode</name> value><int>0</int></value> </member> <member> <name>message</name> <value><string>SUCCESS</string>/value> </member> </struct> </value> </param> </params> </methodResponse>

失敗

<?xml version="1.0" encoding="utf-8"?> <methodResponse> <params> <param> <value> <struct> <member> <name>resultCode</name> <value><int>1</int></value> </member> <member> <name>message</name> <value><string>Resource with the given resource name already exists.</string></value> </member> </struct> </value> </param> </params> </methodResponse>

pmp.password.retrieve

これにより、指定されたユーザー アカウントのパスワードが Password Management Pro リポジトリから取得されます。取得後、Password Management Pro は、管理者への通知や操作の監査など、設定されたすべてのアクションを実行します。

URL: https://pmp-server:7070/xmlrpc

要求パラメータ

名前 種類 必要性 説明

resourceName

String

はい

Password Management Pro 内のリソースの一意の名前。

userAccount

String

はい

パスワードを取得するリソースのアカウント名。

reason

String

オプション

パスワードを取得する理由。

要求パラメータ

名前 説明 値

resultCode

要求されたメソッド呼び出しの結果を説明する数値。

0 - Success
All other values - Failure with reason in the message parameter.

message

resultCode に基づいて、操作の結果の理由を説明するテキスト。

パスワードが必要です

The password returned as a string (or)
[<Message>] on other failure cases

要求 XML の例

<?xml version="1.0" encoding="utf-8"?> <methodCall> <methodName>pmp.password.retrieve</methodName> <params> <param> <value><string>pmp-server</string></value> </param> <param> <value><string>administrator</string></value> </param> </params> </methodCall>

応答 XML の例

成功

<?xml version="1.0" encoding="utf-8"?> <methodResponse> <params> <param> <value> <struct> <member> <name>resultCode</name> <value><int>0</int></value> </member> <member> <name>message</name> <value><string>edhfED45@#f</string></value> </member> </struct> </value> </param> </params> </methodResponse>

失敗

<?xml version="1.0" encoding="utf-8"?> <methodResponse> <params> <param> <value> <struct> <member> <name>resultCode</name> <value><int>1</int></value> </member> <member> <name>message</name> <value><string>Resource with the given resource name does not exist.</string></value> </member> </struct> </value> </param> </params> </methodResponse>

pmp.password.update

これにより、指定されたユーザー アカウントのパスワードが Password Management Pro リポジトリから更新されます。更新後、Password Management Pro は、管理者への通知や操作の監査など、構成されたすべてのアクションを実行します。

URL: https://pmp-server:7070/xmlrpc

pmp.password.retrieve

これにより、指定されたユーザー アカウントのパスワードが Password Management Pro リポジトリから取得されます。取得後、Password Management Pro は、管理者への通知や操作の監査など、設定されたすべてのアクションを実行します。

URL: https://pmp-server:7070/xmlrpc

要求パラメータ

名前 種類 必要性 説明

resourceName

String

はい

Password Management Pro 内のリソースの一意の名前。

userAccount

String

はい

パスワードを取得するリソースのアカウント名。

reason

String

オプション

パスワードを取得する理由。

newPassword

String

オプション

ユーザーアカウントの新しいパスワード。

updateRemote

Boolean

はい

パスワードをリモートで更新する場合は true を設定します。

要求パラメータ

名前 説明 値

resultCode

要求されたメソッド呼び出しの結果を説明する数値。

0 - Success
All other values - Failure with reason in the message parameter.

メッセージ

resultCode に基づいて、操作の結果の理由を説明するテキスト

"SUCCESS" on Success
[<Message>] on other failure cases

要求 XML の例

<?xml version="1.0" encoding="utf-8"?> <methodCall> <methodName>pmp.password.update</methodName> <params> <param> <value><string>pmp-server</string></value> </param> <param> <value><string>administrator</string></value> </param> <param> <value><boolean>true</boolean></value> </param> </params> </methodCall> Example Response XML

成功

<?xml version="1.0" encoding="utf-8"?> <methodResponse> <params> <param> <value> <struct> <member> <name>resultCode</name> <value><int>0</int></value> </member> <member> <name>message</name> <value><string>SUCCESS</string></value> </member> </struct> </value> </param> </params> </methodResponse>

失敗

<?xml version="1.0" encoding="utf-8"?> <methodResponse> <params> <param> <value> <struct> <member> <name>resultCode</name> <value><int>1</int></value> </member> <member> <name>message</name> <value><string>Resource with the given resource name does not exist.</string></value> </member> </struct> </value> </param> </params> </methodResponse>