RESTful API
（本機能はEnterprise Editionのみでサポートされています。）
イントロダクション
Password Manager Pro APIを使用するとPMPと直接接続、連携ができるようになります。 APIはREpresentational State Transfer (REST) カテゴリに属し、GET、PUT、POSTの各メソッドを用いて、リソースやアカウントの追加、SSL証明書やSSH鍵の追加、リソースとSSH鍵の関連付け、パスワードやリソース/アカウント情報の取得、パスワード更新、リソース/アカウントのユーザーへの共有をプログラム上から行うことができます。
前提条件
APIユーザーアカウント作成は、アプリケーション間におけるパスワード管理API構成プロセスの最初のステップです。 APIユーザーアカウントの作成方法についてはこちらをクリックしてください。
API概要
APIを呼び出すメソッド
GET
リソース、アカウント、パスワード、アカウント/リソース情報を取得する方法
PUT
パスワードを変更する方法
POST
新規リソース、アカウントを作成する方法
APIをどのように活用するか
APIの呼び出し
APIは、HTTP POST、GET、PUT リクエストを通じて呼び出すことができます。リクエストにあるすべてのパラメータは「form-urlencoded」である必要があります。 すべてのAPIに対してAUTHトークンを手動で渡す必要があります。
サポート対象のフォーマット
PMPはJSONフォーマットとURL構造を次のようにサポートします。
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>
Header
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
Password Manager Proは以下のリストのように幅広いAPIを提供します。
- ユーザーが所有する、ユーザーに共有されたリソースの取得
- リソースに属するアカウントの取得
- アカウント情報の取得<
- リソースに属するアカウントのパスワードを取得
- アカウントのパスワードを変更
- 新規リソースの作成
- アカウントIDとリソースIDの取得
- リソース名を使用してリソースIDの取得
- PMP上でリソースの削除P
- 管理者（admin）によるパスワード承認のリクエスト
- パスワードリクエストのリスト取得
- パスワードリクエストの拒否
- パスワードリクエストの承認
- 管理者（admin）によるパスワード承認のチェックイン
- 管理者（admin）によるパスワード承認のチェックアウト
- パワードの作成
- 新規ユーザーの作成
- リソースの編集
- 特定のリソースに属するアカウントの削除
- ライセンスキー、ファイル、デジタル証明書、ドキュメント、画像などの取得
- 特定のリソースに属するユーザーの作成
- 特定のリソースに属するアカウントの編集
- ユーザーの削除
- APIユーザーの作成
- 新規SSH鍵の作成
- SSH鍵の削除
- すべてのSSH鍵の取得
- 特定のSSH鍵の取得
- SSH鍵のエクスポート
- ユーザー用のSSH鍵の取得
- 関連するすべてのユーザーの取得
- 証明書の取得
- すべての証明書の取得
- すべての証明書の有効期限の取得
- 証明書情報の取得
- 証明書鍵ストアの取得
- 証明書パスフレーズの取得
- 証明書の追加
- 証明書の削除
- リソースディスカバリの実行
- リソースディスカバリの実行（IPアドレス範囲）
- CSRの作成
- CSRリストの取得
- CSRへの署名
- 証明書の作成
- ユーザーのIDを取得
- ユーザー名を使用してユーザーの削除
- ユーザーをユーザーグループに追加
- ユーザーのロック
- ユーザーのロック解除
- SSH鍵のインポート
- SSH鍵と関連付け
- SSH鍵と関連付けを解除
- 動的リソースグループの作成
- 監視情報の取得
- リソースをユーザーに共有
- アカウントをユーザーに共有
- リソースをユーザーグループに共有
- アカウントをユーザーグループに共有
- ユーザーグループIDの取得
- Linuxリソースのパスワード変更用の資格情報を設定
- SSL証明書のデプロイ
- ユーザーにSSL証明書を共有する
- ユーザーグループにSSL証明書を共有する
- ユーザーにSSL証明書グループを共有する
- ユーザーグループにSSL証明書グループを共有する
- ユーザーからSSL証明書を剥奪する
- ユーザーグループからSSL証明書を剥奪する
- ユーザーからSSL証明書グループを剥奪する
- ユーザーグループからSSL証明書グループを剥奪する
- SSL証明書グループを作成する
- SSL証明書グループを削除する
- SSL証明書グループを編集する
- エージェントインストール鍵を生成する
- パスワードポリシーの取得
- リソース種別の取得
- リソースをリソースグループに関連付ける
- リソースグループからリソースの関連付けを解除する
- リソースに関連付けられたリソースグループの取得
- リソースグループの削除
- リソースグループIDの取得
- 2段階認証のリセット
(PMPバージョン10102以降に適用されます。)
注意:
PMPサーバーへの各APIコールでは、リクエストヘッダーのみに認証トークン（AUTHTOKEN）を渡す必要があります。
1. ユーザーが所有する、ユーザーに共有されたリソースの取得
説明
APIユーザーが所有、共有しているリソースの一覧を取得する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
GET
入力データ
なし
リクエスト例
curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources
出力サンプル
出力では（以下に表示されているサンプルのように）、特定のAPIユーザーが所有、共有するすべてのリソースを取得します。
{
"operation" : {
"name" : "GET RESOURCES" ,
"result " : {
"status" : "Success",
"message" : "Resources fetched successfully"
},
"totalRows":3,
"Details": {
{
"RESOURCE DESCRIPTION":"CentOS Machine",
"RESOURCE NAME":"CentOS Machine",
"RESOURCE ID":"301",
"RESOURCE TYPE":"Linux",
"NOOFACCOUNTS" : "3"
},
{
"RESOURCE DESCRIPTION":"Cisco IOS Device",
"RESOURCE NAME":"Cisco IOS Device",
"RESOURCE ID":"302",
"RESOURCE TYPE":"Cisco IOS",
"NOOFACCOUNTS":"2"
},
{
"RESOURCE DESCRIPTION":"Weblogic Data Source Password",
"RESOURCE NAME":"WebLogic Server",
"RESOURCE ID":"303",
"RESOURCE TYPE":"WebLogic Server",
"NOOFACCOUNTS":"2"
}
} }
}
2. リソースに属するアカウントの取得
説明
リソースにあるアカウントのリストとリソース情報を取得する方法。リソースIDはGET RESOURCES APIから取得することができます。 (上記の通り)
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
GET
入力データ
なし
リクエスト例
curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/303/accounts
出力サンプル
出力において（下記のサンプルのように）、特定のAPIユーザーが所有、共有しているすべてのリソースを取得することができます。
{
"operation":{
"name":"GET RESOURCE ACCOUNTLIST",
"result ":{
"status": "Success ,
"message":"Resource details with account list fetched successfully"
},
"Details":{
"RESOURCE ID":"303",
"RESOURCE NAME":"MSSQL server",
"RESOURCE DESCRIPTION" :"WebLogic Data source password",
"RESOURCE TYPE":"MS SQL server",
"DNS NAME":" sqlserver-l",
"PASSWORD POLICY":"Strong",
"DEPARTMENT": "SQL Server DBA" ,
"LOCATION":"Level 10",
"RESOURCE URL":"http://sqlserver-1/",
"RESOURCE OWNER": "admin",
"CUSTOM FIELD":{
"CUSTOMFIELDVALUE":"78336298",
"CUSTOMFIELDTYPE":"Numeric",
"CUSTOMFIELDLABEL":"License No" ,
"CUSTOMFIELDCOLUMNNAME":"COLUMN_LONG1"
},{
"CUSTOMFIELDVALUE":"Sep 10, 2013",
"CUSTOMFIELDTYPE" : "Date",
"CUSTOMFIELDLABEL":" Installed Date",
"CUSTOMFIELDCOLUMNNAME" "COLUMN_DATE1"
}, {
"CUSTOMFIELDVALUE":"Tese123$*%%,
"CUSTOMFIELDTYPE":"Password",
"CUSTOMFIELDLABEL":"Resource Password", "CUSTOMFIELDCOLUMNNAME":"COLUMN_SCHAR1"
},
{
"CUSTOMFIELDVALUE":"YES"
"CUSTOMFIELDTYPE":"Character",
"CUSTOMFIELDLABEL":"Secure Resource",
"CUSTOMFIELDCOLUMNNAME":"COLUMN_CHAR1"
}
},
"ACCOUNT LIST": {
{
"ISFAVPASS": "false",
"ACCOUNT NAME":"sysdba",
"PASSWDID":"308",
"PASSWORD STATUS":"[In Use]",
"ACCOUNT ID":"308"
},
{
"ISFAVPASS":"false",
"ACCOUNT NAME":"system",
"PASSWDID":"307"
"PASSWORD STATUS":"*****",
"ACCOUNT ID":"307"
}
}
}
} }
注意: パスワードのアクセスコントロールが有効であり、尚且つパスワードステータスが「IN USE」である場合、「In use」として出力表示されます。
3. アカウント情報の取得
説明
リソースに属するアカウントの情報を取得するには、リソースIDとアカウントIDの両方を渡して必要な情報を取得します。
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
GET
入力データ
なし
リクエスト例
curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/303/accounts/307
出力サンプル
{
"operation":{
"name":"GET RESOURCE ACCOUNT DETAILS",
result":{
status":"Success",
message":"Account details fetched successfully"
},
"Details":{
"DESCRIPTION":"",
"LAST ACCESSED TIME":"N/A",
"LAST MODIFIED TIME":"Sep 10, 2013 3:33 PM",
"PASSWORD STATUS":"*****",
"PASSWDID":"307",
"CUSTOM FIELD":[
{
"CUSTOMFIELDVALUE": "56455567",
"CUSTOMFIELDTYPE":"Numeric",
"CUSTOMFIELDLABEL":"Account LIC Number",
"CUSTOMFIELDCOLUMNNAME":"COLUMN_LONG1"
},
{
"CUSTOMFIELDVALUE": "Sep 10, 2013",
"CUSTOMFIELDTYPE":"Date",
"CUSTOMFIELDLABEL":"Acc creation date",
"CUSTOMFIELDCOLUMNNAME":"COLUMN_DATE1"
},
{
"CUSTOMFIELDVALUE": "Test12345",
"CUSTOMFIELDTYPE":"Password",
"CUSTOMFIELDLABEL":"Secondary Password",
"CUSTOMFIELDCOLUMNNAME":"COLUMN_SCHAR1"
},{
"CUSTOMFIELDVALUE": "YES",
"CUSTOMFIELDTYPE":"Character",
"CUSTOMFIELDLABEL":"Secure Account",
"CUSTOMFIELDCOLUMNNAME":"COLUMN_CHAR1"
}
]
}
}
}
4. リソースに属するアカウントパスワードの取得
説明
リソースに属するアカウントのパスワードを取得するには、リソースIDとアカウントIDの両方を渡して必要な情報を取得します。
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>/password
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
GET
入力データ
パスワードを取得するために理由の入力が強制されるケースがあります。次の情報を入力として渡す必要があります。チケットシステムが有効な場合、検証用にチケットIDを渡す必要があります。
INPUT_DATA={"operation":{"Details":{"REASON":"Need the password to Login Windows Server","TICKETID":"7"}}}
リクエスト例
curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/303/accounts/307/password
curl -X GET -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" --url -d 'https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/303/accounts/307/password?INPUT_DATA=\{"operation":\{"Details":\{"REASON":"Need the password to Login Windows Server","TICKETID":"7"\}\}\}'
出力サンプル
{
"operation":{
"name":"GET PASSWORD",
"result":{
"status": "Success",
"message":"Password fetched successfully"
},
"Details":{
"PASSWORD":"fqxdB7ded@4"
}
}
}
注意: パスワードの取得で何か問題が発生した場合、その理由がメッセージの一部として表示されます。
5. アカウントのパスワードを変更
説明
リソースに属するアカウントのパスワードを変更するにはリソースIDとアカウントIDの両方を渡して、必要な情報を取得する必要があります。チケットシステムが有効な場合、検証用にチケットIDを渡す必要があります。
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>/password
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
PUT
入力データ
新規パスワード、リセットタイプや理由を入力データとして渡す必要があります。また、リセットタイプはLOCAL、またはREMOTEのいずれかである必要があります。
INPUT_DATA={
"operation":{
"Details":{
"NEWPASSWORD":"Test@12345$",
"RESETTYPE":"LOCAL",
"REASON":"Password Expired",
"TICKETID":"7"
}
}
}
リクエスト例
curl -X PUT -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" --url https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/303/accounts/307/password?INPUT_DATA=\{"operation":\{"Details":\{"NEWPASSWORD":"Test12345$","RESETTYPE":"LOCAL","REASON":"test","TICKETID":"7"\}\}\}
出力サンプル
{
"operation":{ "name":"CHANGE PASSWORD",
"result":{
"status":"Success",
"message":"Password changed successfully"
}
}
}
注意: パスワードの変更において何か問題が発生した場合、その理由がメッセージの一部として表示されます。
6. 新規リソースの作成
説明
PMPで新規リソースを作成する方法
入力データ
リソースやアカウントレベルにおいて、リソースの名称、アカウント名、リソースタイプ、パスワード、URL、説明、メモ、その他の追加フィールドなどの入力データを渡す必要があります。 最大40のカスタムフィールドを追加することができます。（リソースレベルで20、アカウントレベルで20）これらのリソース名、アカウント名、リソースタイプやパスワードは入力必須です。
INPUT_DATA={
"operation":{
"Details":{
"RESOURCENAME":"Windows Server",
"ACCOUNTNAME":"Administrator",
"RESOURCETYPE":"Windows",
"PASSWORD":"Test123#@!",
"NOTES":"Testing API",
"RESOURCEURL":"http://windowsserver/adminconsole",
"RESOURCEPASSWORDPOLICY":"Strong",
"ACCOUNTPASSWORDPOLICY":"Strong",
"RESOURCECUSTOMFIELD":[
{
"CUSTOMLABEL":"Secure Resource",
"CUSTOMVALUE":"YES"
}
],
"ACCOUNTCUSTOMFIELD":[
{
"CUSTOMLABEL":"Secure Account",
"CUSTOMVALUE":"YES"
}
]
}
}
}
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
リクエスト例
curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "content-Type: text/json" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources -d 'INPUT_DATA={"operation":{"Details":{"RESOURCENAME":"Windows Server","ACCOUNTNAME":"Administrator","RESOURCETYPE":"Windows","PASSWORD" :"Test@123,"RESOURCEPASSWORDPOLICY":"Strong","ACCOUNTPASSWORDPOLICY":"Strong","RESOURCECUSTOMFIELD":[{"CUSTOMLABEL":"Secure Resource","CUSTOMVALUE":"YES"}],"ACCOUNTCUSTOMFIELD":[{ "CUSTOMLABEL":"Secure Account","CUSTOMVALUE":"YES"}]}}}'
出力サンプル
{
"operation":{
"name":"CREATE RESOURCE",
"result":{
"status":"Success",
"message":"Resource Windows Server has been added successfully"
}
}
注意: 管理者/パスワード管理者/特権管理者に新規リソースを追加する場合は、特定のユーザーの値を含む追加のパラメータ 「OWNERNAME」をリソース情報に追加する必要があります。リソースをADユーザーに追加するとき、ユーザー名は「Domain-Name\\UserName」形式で入力する必要があります。
INPUT_DATA={
"operation":{
"Details":{
"RESOURCENAME":"Windows Server",
"ACCOUNTNAME":"Administrator",
"RESOURCETYPE":"Windows",
"PASSWORD":"Test@123!",
"NOTES":"Testing API",
"RESOURCEURL":"http://windowsserver/adminconsole",
"OWNERNAME":"admin",
"RESOURCECUSTOMFIELD":[
{
"CUSTOMLABEL":"Secure Resource",
"CUSTOMVALUE":"YES"
}
],
"ACCOUNTCUSTOMFIELD":[
{
"CUSTOMLABEL":"Secure Account",
"CUSTOMVALUE":"YES"
}
]
}
}
}
注意: リソースを静的リソースグループへ追加する場合、その特定のリソースグループの値を含む追加のパラメータ「RESOURCEGROUPNAME」をリソース作成の入力に追加する必要があります。
グループが既に存在する場合、そのリソースはグループに追加されるか、ここで指定した名前の新規グループが作成されます。
INPUT_DATA={
"operation":{
"Details":{
"RESOURCENAME":"Windows Server",
"ACCOUNTNAME":"Administrator",
"RESOURCETYPE":"Windows",
"PASSWORD":"Test123#@!",
"NOTES":"Testing API",
"RESOURCEURL":"http://windowsserver/adminconsole",
"RESOURCEGROUPNAME":"Windows Servers",
"RESOURCECUSTOMFIELD":[
{
"CUSTOMLABEL":"Secure Resource",
"CUSTOMVALUE":"YES"
}
],
"ACCOUNTCUSTOMFIELD":[
{
"CUSTOMLABEL":"Secure Account",
"CUSTOMVALUE":"YES"
}
]
}
}
}
注意: ファイルをPMPに別々のリソースとして追加することもできます。ファイルを新規リソースとして追加するには、リクエストの「Content-Type」を次のサンプルのように変更する必要があります。変更後、その内容をファイルに含めて渡します。
INPUT_DATA={
"operation":{
"Details":{
"RESOURCENAME":"Active Directory",
"ACCOUNTNAME":"Administrator",
"RESOURCETYPE":"License Store",
"PASSWORD":"Test123#@!",
"NOTES":"Testing API",
"RESOURCEURL":"http://windowsserver/adminconsole"
}
}
}
リクエスト例
curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: multipart/form-data" -F 'file=@standalonesample.txt' -F 'INPUT_DATA={"operation":{"Details":{"RESOURCENAME":"Windows erver","ACCOUNTNAME":"Administrator","RESOURCETYPE":"File Store","PASSWORD":"Test123#@!","NOTES":"Testing API","RESOURCEURL":"http://windowsserver/adminconsole"}}}' "https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources"
7. アカウントIDやリソースIDの取得
説明
アカウントIDやリソースIDを取得するには、URLにリソース名とアカウント名を渡す必要があります。
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/getResourceIdAccountId? RESOURCENAME=(Resourcename)&ACCOUNTNAME=(Account name)
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
GET
入力データ
なし
リクエスト例
curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" "https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/getResourceIdAccountId?RESOURCENAME=MSSQLServer&ACCOUNTNAME=system"
出力サンプル
{
"operation":{
"name":"GET_RESOURCEACCOUNTID",
"result":{
"status":"Success",
"message":"Resource ID and account ID fetched successfully for the given resource
name and account name."
},
"Details":{
"RESOURCEID":"303",
"ACCOUNTID":"307"
}
}
}
8. リソース名を使用してリソースIDを取得する方法
説明
リソースIDを取得するには、URLにリソース名のみを入力します。
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/resourcename/{RESOURCENAME}
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
GET
入力データ
なし
リクエスト例
curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/resourcename/test
出力サンプル
{"operation":{ "name": "GET_RESOURCEID", "result":{ "status": "Success", "message": "Resource ID fetched successfully for the given resource name." }, "Details":{ "RESOURCEID": "1" } }
9. PMP上でリソースの削除
説明
指定されたリソースIDのリソースを削除します。リソースIDはGET RESOURCES API から取得することができます。（上記の通り）
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/{resourceid}
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
DELETE
入力データ
なし
リクエスト例
curl -X -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" DELETE https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/307
出力サンプル
{
"operation":{
"name":"DELETE RESOURCE"
"result":{"status":"Success"
"message":"Resources deleted successfully."}
}
10. 管理者（admin）によるパスワード承認のリクエスト
説明
パスワードアクセスの承認を管理者（admin）にリクエストする方法。アカウントIDはURLの同じものに対して渡されなければなりません。
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/{accountid}/requestpassword
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
入力データ
最後の設定でパスワードをリクエストする理由が必要な場合は、次の情報を入力として渡す必要があります。INPUT_DATA= { "operation" : { "Details" : { "REASON" : "asdefefe"}}}
入力サンプル
{
"operation":{
"Details":{
PASSWDID":"1"
"REASON":"Testing"
}
}
}
リクエスト例
curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/7/requestpassword?INPUT_DATA= { "operation" : { "Details":{ "REASON" : "Testing"}}}
出力サンプル
{
"operation":{
"name":"REQUEST_PASSWORD" ,
"result":{
"status":"Success" ,
"message":"Request to view password have been raised successfully"
},
"Details":{
"STATUS" : "WAITING FOR APPROVAL / CHECKOUT" ;
}
}
}
11. パスワードリクエストのリストの取得
説明
ログインしている管理者（admin）が承認、または拒否するパスワードリクエストのリストを取得する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/passwordaccessrequests
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
GET
入力データ
なし
入力サンプル
INPUT_DATA= { "operation" : { "Details" : { "REASON" : "Testing", "TICKETID" : "7"}}}
リクエスト例
curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/passwordaccessrequests
出力サンプル
{
"operation":{
"name":"GET_PASSWORDREQUEST"
"result":{
"status":"Success"
"message" : "Password Request fetched successfully"
}
"Details": {
"REQUESTER USERID":"2"
"REQUESTED BY":"guest"
"REQUESTED BY FULLNAME" : "Guest guest"
"PASSWORDREQUESTLIST" : [
{
"ACCOUNT ID" : "1"
"ACCOUNT NAME" : "ACCOUNT1"
"RESOURCE ID":"1"
"RESOURCE NAME":"apt-server1"
"PASSWD ID" : "1"
"STATUS":""
"REQUESTED TIME":"Nov 27
"REASON" : "For connecting the machine and update the PMP server".
}
{
"ACCOUNT ID" : "2"
"ACCOUNT NAME" : "ACCOUNT2"
"RESOURCE ID":"2"
"RESOURCE NAME":"apt-server2"
"PASSWD ID" : "2"
"STATUS":""
"REQUESTED TIME":"Nov 28
"REASON" : "For connecting the machine and update the PMP server".
}
]
}
}
}
注意 : 依頼者IDはパスワードをリクエストしたユーザーのIDと同じである必要があります。
12. パスワードリクエストの拒否
説明
管理者（admin）がパスワードリクエストを拒否する方法。これにはアカウントと依頼者IDがURLに渡されている必要があります。
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/{accountid}/requester/{requesterid}/reject
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
入力サンプル
{
"operation":{
"Details":{
"PASSWDID":"1"
"REQUESTEDID" : "2" (userid of the request raised user)
}
}
}
注意: 依頼者IDはパスワードをリクエストしたユーザーのIDと同じである必要があります。
リクエスト例
curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/7/requester/34/reject
出力サンプル
{
"operation":{
"name" : "ADMIN_REQUEST_REJECT"
"result" : {
"status" : "Success"
"message": "Password Rejected successfully"
}
}
}
13. パスワードリクエストの承認
説明
管理者（admin）がパスワードリクエストを承認する方法。ここでは、アカウントIDと依頼者IDはURLで渡されている必要があります。
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/{accountid}/requester/{requesterid}/approve
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
入力データ
なし
注意: 依頼者IDはパスワードをリクエストしたユーザーのIDと同じである必要があります。REQUESTEDIDは、GET PASSWORDREQUEST API(REQUESTER USERID)から取得されます。
リクエスト例
curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/7/requester/34/approve
出力サンプル
{
"operation" : {
"name" : "ADMIN_REQUEST_APPROVE"
"result" : {
"status" : "Success"
"message": "Password Approved successfully"
}
}
}
14.管理者（admin）が承認したパスワードのチェックイン
説明
管理者（admin）が承認したパスワードをチェックインする方法。アカウントIDと依頼者IDは同じURLで渡されている必要があります。
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/{accountid}/requester/{requesterid}/checkin
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
入力データ
{
"operation":{
"Details":{
"PASSWDID" : "1"
"REQUESTEDID" : "2" (userid of the request raised user)
}
}
注意: 依頼者IDはパスワードをリクエストしたユーザーのIDと同じである必要があります。
リクエスト例
curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/7/requester/34/checkin
出力サンプル
{
"operation":{
"name" : "ADMIN_REQUEST_CHECKIN"
"result" : {
"status" : "Success"
"message" : "Password have been checked in successfully"
}
}
}
15. 管理者（admin）が承認したパスワードのチェックアウト
説明
リクエスト後に管理者（admin）が承認したパスワードをチェックアウトする方法。アカウントIDはURLで同じように提供されている必要があります。
URL
https://:<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/{accountid}/checkout
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
入力データ
パスワードのチェックアウトの理由を要求するカスタマイズされた設定のアカウントでは、入力として次のように渡す必要があります。 INPUT_DATA= { "operation" : { "Details":{ "REASON" : "asdefefe"}}}
入力サンプル
{
"operation":{
"Details":{
"REASON":"N/A"
}
}
}
リクエスト例
curl -X POST -k-H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/7/checkout?INPUT_DATA= { "operation" : { "Details" : { "REASON" : "N/A"}}}
出力サンプル
{
"operation": {
"name" : "REQUEST_CHECKOUT" "result" : {
"status" : "Success"
"message" : "Password have been checked out successfully"
"Details":{
"STATUS" : "***** [checkIn]"
}
}
}
16. パスワードの生成
説明
PMPで既存のポリシーを使用してパスワードを生成する方法
URL
https:// <Host-Name-of-PMP-Server OR IP address> :<Port>/restapi/json/v1/passwords/generate
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
GET
入力データ
INPUT_DATA={ "operation" : { "Details" : { "POLICY" : "Strong"}}}
出力サンプル
{
"operation": {
"name": "GENERATE PASSWORD",
"result": {
"status": "Success",
"message": "Password generated successfully."
},
"Details": {
"PASSWORD": "u%mdh7gfN"
}
}
}
17. 新規ユーザーの作成
説明
新規ユーザーの作成方法
URL
https:// <Host-Name-of-PMP-Server OR IP address> :<Port>/restapi/json/v1/user
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
入力データ
INPUT_DATA={"operation": {"Details":{"USERNAME":"jason1", "FIRSTNAME":"Jason","LASTNAME":"J","FULLNAME":"JasonThomas","EMAIL":"jason@opmanager.com","POLICY":"Strong","ROLE":"Password User","ISSUPERADMIN":"true|false","PASSWORD":"Test@123","DEPARTMENT":"NOC","LOCATION":"Level 10 - South Wing","ISAPIUSER":"false","HOSTNAME":"admin-2100","EXPIRYDATE":"yyyy-mm-dd|NeverExpires"}}}
出力サンプル
{
"operation": {
"name": "CREATE_USER",
"result": {
"status": "Success",
"message": "User Created Successfully"
}
}
}
18. リソースの編集
説明
リソースを編集する方法
URL
https://severname:port/restapi/json/v1/resources/{RESOURCEID}
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
PUT
入力データ
（オプションの入力はグレーで指定されています。）
入力サンプル
注意: リソースタイプを編集する場合、管理者（admin）はその特定のリソースのタイプの値を持つ追加パラメータ「RESOURCETYPE」を入力に追加する必要があります。 リソースタイプを編集するとき、キーストア、ファイルストア、ライセンスストア、Rackspace、AWS IAMからほかのリソースタイプに変更することができません。また、その逆も同様です。
{
"operation" : {
"Details": {
"RESOURCENAME" : "Test",
"LOCATION" : "4th floor",
"RESOURCEURL" : "http://test",
"RESOURCEPASSWORDPOLICY":"Strong",
"DEPARTMENT" : "Test",
"RESOURCEDESCRIPTION" : "Created for quality assurance",
"RESOURCETYPE" : "Windows",
"RESOURCECUSTOMFIELD" : [
{
"CUSTOMLABEL" : "Secure Resource",
"CUSTOMVALUE" : "YES"
}
]
}
}
}
リクエスト例
curl -X PUT -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" 'https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/1? -d 'INPUT_DATA={"operation":{"Details":{"RESOURCENAME":"Test","LOCATION":"4thfloor","RESOURCEURL":"http://test","RESOURCEPASSWORDPOLICY":"Strong","DEPARTMENT": "Test", RESOURCEDESCRIPTION" : "Created for quality assurance", "RESOURCECUSTOMFIELD" : [{"CUSTOMLABEL" : "Secure Resource", "CUSTOMVALUE" : "YES" }]}}}'
出力サンプル
{"operation":{ "name":"EDIT RESOURCE", "result":{"status":"Success","message":"Resource Test modified successfully."}}}
19. 特定のリソースに属するアカウントの削除
説明
特定のリソースに属するアカウントの削除方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>/
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
DELETE
リクエスト例
curl -X DELETE -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" 'https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/1/accounts/1
出力サンプル
{ "operation":{
"name":"DELETE ACCOUNT",
"result":{"status":"Success","message":"Account Test123 deleted successfully."}}}
20. ライセンスキー、ファイル、デジタル証明書、ドキュメント、画像などの取得
説明
個々のリソース、またはほかのリソースに属するファイル、鍵、証明書などの取得する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>/downloadfile
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
GET
入力データ
最後の設定でファイルのダウンロードに理由が必要な場合、入力として次の情報を渡す必要があります。また、チケットシステムが有効な場合、検証用にチケットIDを提供する必要があります。
{"operation":{
"Details":{
"REASON":"Need the key file to connect the remote host", //optional when reason is forced
"TICKETID":"7", // optional when ticketing system is enabled
"ISCUSTOMFIELD":"true" //optional Need to be given if the file to be downloaded is account/resource additional field file type
"CUSTOMFIELDTYPE":"ACCOUNT / RESOURCE" // optional -If its account additional field it must be ACCOUNT or if its resource
additional field it must be RESOURCE
"CUSTOMFIELDLABEL" : "LicenseFIle" // optional - Name of the resource/account additional field
}
}
}
リクエスト例
curl -i -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/1501/accounts/3601/downloadfile
21. 特定のリソースに属するアカウントの作成
説明
特定のリソースIDに関連づけられた複数のアカウントの作成方法
入力データ
アカウントリスト、アカウントの名称、パスワード、説明のような入力データを提供する必要があります。
INPUT_DATA={"operation":{
"Details":{
"ACCOUNTLIST": [
{
"ACCOUNTNAME":"bestest047",
"PASSWORD":"Pa$$Word@123",
"ACCOUNTPASSWORDPOLICY":"Strong",
"NOTES":"IT Security - BES PMP API Test"
},
{
"ACCOUNTNAME":"bestest048",
"PASSWORD":"Pa$$Word@123",
"ACCOUNTPASSWORDPOLICY":"Strong",
"NOTES":"IT Security - BES PMP API Test"
}
]
}
}
}
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
リクエスト例
curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" 'https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/1/accounts INPUT_DATA= {"operation":{ "Details":{ "ACCOUNTLIST": [{ "ACCOUNTNAME": "bestest047","PASSWORD":"Pa$$Word@123","ACCOUNTPASSWORDPOLICY":"Strong","NOTES":"IT Security - BES PMP API Test"},{"ACCOUNTNAME":"bestest048", "PASSWORD":"Pa$$Word@123","ACCOUNTPASSWORDPOLICY":"Strong","NOTES":"IT Security - BES PMP API Test"}]}}
出力サンプル
{"operation":
{"name":"ADD ACCOUNTS","result":
{"status":"Success","message":"Account added successfully"},
"Details":[
{"bestest047":{"STATUS":"Account added successfully"},
"bestest048":{"STATUS":"Account added successfully"}}]}}
22. 特定のリソースに属するアカウントの編集
説明
特定のリソースに属するアカウントの編集方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>/
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
PUT
入力サンプル
{ "operation" : { "Details" : { "ACCOUNTNAME" : "Test account", "ACCOUNTPASSWORDPOLICY":"Strong", "NOTES":"Created for quality assurance", "ACCOUNTCUSTOMFIELD" : [ { "CUSTOMLABEL" : "Secure Account", "CUSTOMVALUE" : "YES" } ] } } }
リクエスト例
curl -X PUT -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json" 'https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/1/accounts/1?-d INPUT_DATA= {"operation":{ "Details":{"ACCOUNTNAME" : "Test account","ACCOUNTPASSWORDPOLICY":"Strong","NOTES":"Created for quality assurance", ACCOUNTCUSTOMFIELD" : [{"CUSTOMLABEL" : "Secure Account", "CUSTOMVALUE" : "YES"}]}}}
出力サンプル
{"operation":{ "name":"EDIT ACCOUNT", "result":{"status":"Success","message":"Account Test account modified successfully"}}}
23. ユーザーの削除
説明
特定のユーザーを削除する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/{userid}
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
DELETE
リクエスト例
curl -X DELETE -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>"
-H "Content-Type: text/json"https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/307
出力サンプル
{"operation":{"name":"DELETE USER","result":{"status":"Success","message":"User Michael deleted Successfully"} } }
24. APIユーザーの作成
説明
APIユーザーの作成メソッド
URL
https:// <Host-Name-of-PMP-Server OR IP address> :<Port>/restapi/json/v1/user
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
入力データ
INPUT_DATA={"operation":{"Details":{"USERNAME":"jason","FULLNAME":"Jason
Thomas","EMAIL":"jason@opmanager.com","POLICY":"Strong","ROLE":"Password
User","ISSUPERADMIN":"true|false","DEPARTMENT":"NOC","LOCATION":"Level 10 - South
Wing","ISAPIUSER":"true","HOSTNAME":"admin-2100","EXPIRYDATE":"yyyy-mm-dd|NeverExpires"}}}
出力サンプル
{"operation":{"name":"CREATE_USER","result":{"status":"Success","message":"SUCCESS"},
"Details":{"AUTHTOKEN":"7D94xxxB-CxxB-44F5-xxxx-931xxxxxx}}}
25. 新規SSH鍵の作成
説明
SSH鍵の作成メソッド
URL
https:// <Host-Name-of-PMP-Server OR IP address> :<Port>/api/pki/restapi/createsshkey
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
入力データ
次は入力データとして提供される必要があります:
{"operation":{"Details":{"keyName":"keytest",
"passPhrase":"passPhrase",
"comment":"comment",
"length":"2048",
"keyType":"ssh-rsa"}}}
リクエスト例
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/createsshkey?INPUT_DATA={"operation":{"Details":{"keyName":"keytest","passPhrase":"passPhrase","comment":"comment","length":"2048","keyType":"ssh-rsa"}}}
レスポンス例
{ "name": "CreateSSHKey",
"result": {
"status": "Success",
"message": "New SSH key created successfully" }
}
注意: 新規SSH鍵の作成に使用できる鍵タイプは次のとおりです：
- ssh-rsa (key length: 1024/2048/4096)
- ssh-dss (key length: 1024)
- ed25519 (no specific key length)
- ecdsa (key length: 256/384/521)
26. SSH鍵の削除
説明
特定のSSHを削除するメソッド
URL
https://< Host-Name-of-PMP-Server OR IP address >:<Port>/api/pki/restapi/deleteSSHKey
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
DELETE
入力データ
次は入力データとして提供される必要があります。
{"operation":{"Details":{"key_name":"newkey1","withoutDisassociation":"true"}}}
リクエスト例
https://< Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/deleteSSHKey?INPUT_DATA={"operation":{"Details":{"key_name":"newkey1","withoutDisassociation":"true"}}}
レスポンス例
{ "name": "DeleteSSHKey", "result": { "status": "Success", "message": "SSH keys newkey1 deleted successfully"}}
27. すべてのSSH鍵の取得
説明
ディスカバリされたすべてのSSH鍵の取得方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getAllSSHKeys
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
GET
入力データ
なし
リクエスト例
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/getAllSSHKeys
レスポンス例
{ "name": "GetAllSSHKeys", "result": { "status": "Success", "message": "All SSH Keys fetched successfully" }, "totalRows": 1, "details": [ { "KeyName": "testkey", "KeyType": "ssh-rsa", "KeyLength": "2048", "FingerPrint": "SHA256:v28/AlRYrpBKjAp4JoTRphLOkFdVb1ummVcyFHSfC5I", "isPassphraseAvailable": false, "CreatedBy": "mm", "CreationTime": "Today" } ] }
28. 特定のSSH鍵を取得
説明
ディスカバリした鍵から特定のSSH鍵の取得方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getSSHKey
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
入力データ
操作名称と入力データとして提供される鍵
{"operation":{"Details":{"keyName":"key"}}}
リクエスト例
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/getSSHKey?INPUT_DATA={"operation":{"Details":{"keyName":"key"}}}
レスポンス例
{ "name": "GetSSHKey", "result": { "status": "Success", "message": "SSH Key testkey fetched successfully" }, "details": [ { "KeyName": "testkey", "KeyType": "ssh-rsa", "KeyLength": "2048", "FingerPrint": "SHA256:v28/AlRYrpBKjAp4JoTRphLOkFdVb1ummVcyFHSfC5I", "isPassphraseAvailable": false, "CreatedBy": "mm", "CreationTime": "Today" } ] }
29. SSH鍵のエクスポート
説明
特定のSSH鍵をエクスポートするメソッド
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/exportSSHKey
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
入力データ
操作名称と入力データとして提供される鍵
{"operation":{"Details":{"keyName":"key"}}}
リクエスト例
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/exportSSHKey?INPUT_DATA={"operation":{"Details":{"keyName":"key"}}}
レスポンス例
Key file
30.ユーザー用にSSH鍵の取得
説明
特定のユーザーに関連するすべてのSSH鍵の取得
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getSSHkeysforuser
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
GET
入力データ
ユーザー名とリソース名は入力データとして提供される必要があります。
{"operation":{"Details":{"userName":"test","resourceName":"172.21.xxx.xx"}}}
リクエスト例
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/getSSHkeysforuser?INPUT_DATA={"operation":{"Details":{"userName":"test","resourceName":"172.21.xxx.xx"}}}
レスポンス例
{ "name": "GetSSHKeysForUser", "result": { "status": "Success", "message": "SSH keys for user test of resource pmp-centos6 fetched successfully" }, "details": "testkey,testkey1" }
31. 関連するすべてのユーザーの取得
説明
SSH鍵に関連付けられているすべてのユーザーの取得方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getAllAssociatedUsers
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
GET
入力データ
なし
リクエスト例
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/getAllAssociatedUsers
レスポンス例
{ "name": "GetAllAssociatedUsers", "result": { "status": "Success", "message": "All associated users fetched successfully" }, "totalRows": 1, "details": [ { "UserName": "test", "ResourceName": "pmp-centos6" } ] }
32. 証明書の取得
説明
PMPの証明書レポジトリから証明書を取得する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getCertificate
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
GET
入力データ
操作情報や取得した証明書の名称は入力としてパスされる必要があります。
{ "operation": {
"Details" : {
"common_name" : "*.google.com", "serial_number":"XXXXXXXXXXXXXX" // optional to provide serial number to fetch certificate details } } }
リクエスト例
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/getCertificate?INPUT_DATA={"operation":{"Details":{"common_name":"*.google.com","serial_number":"XXXXXXXXXXXXXX"}}}
レスポンス例
Certificate object
33. 全ての証明書の取得
説明
PMPの証明書レポジトリからすべての証明書を取得する方法
HTTPメソッド
GET
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getAllSSLCertificates
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
入力データ
INPUT_DATA={"operation":{"Details":{"withExpiryDaysLessThan":"500","withKeyLength":"1024","withSignatureAlgorithm":"SHA1"}}}
リクエスト例
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/getAllSSLCertificates?INPUT_DATA={"operation":{"Details":{"withExpiryDaysLessThan":"500"}}}
レスポンス例
{ "name": "GetAllSSLCertificates", "result": { "status": "Success", "message": "All SSL Certificates fetched successfully" }, "totalRows": 2, "details": [ { "CertID": 1, "DNS Name/FQDN": "paytm.com", "Port": 443, "Common Name": "*.paytm.com", "Issuer": "GeoTrust Inc.", "FromDate": "Oct 13, 2015", "ExpiryDate": "Aug 27, 2017", "KeyStrength": "2048", "SignatureAlgorithm": "SHA256withRSA" }, { "CertID": 302, "DNS Name/FQDN": "204.141.32.155", "Port": 443, "Common Name": "*.zoho.com", "Issuer": "Sectigo Limited", "FromDate": "Jul 2, 2019", "ExpiryDate": "Apr 30, 2021", "KeyStrength": "2048", "SignatureAlgorithm": "SHA256withRSA" } ] }
注意: Including the Input Data in the API request is optional. In case input data is provided, you can add any one or all of the available filters: withExpiryDaysLessThan,withKeyLength,withSignatureAlgorithm.
34. 証明書の有効期限の取得
説明
すべての証明書の有効期限を取得する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getAllSSLCertsExpiryDate
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
GET
入力データ
なし
リクエスト例
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/getAllSSLCertsExpiryDate
レスポンス例
{ "name": "GetAllSSLCertificatesExpiryDate", "result": { "status": "Success", "message": "Certificates expiry date fetched successfully" }, "totalRows": 2, "details": [ { "Common Name": "*.paytm.com", "ExpiryDate": "Aug 27, 2017" }, { "Common Name": "*.zoho.com", "ExpiryDate": "Apr 30, 2021" } ] }
35. 証明書情報の取得
説明
特定の証明書の情報を取得する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getCertificateDetails
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
GET
入力データ
操作情報と取得した証明書の名称は入力として渡す必要があります。
{"operation": {"Details":{"common_name":"*.google.com"}}}
リクエスト例
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/getCertificateDetails?INPUT_DATA={"operation": {"Details":{"common_name":"*.google.com"}}}
レスポンス例
{ "name": "GetCertificateDetails", "result": { "status": "Success", "message": "Details of certificate *.zoho.com fetched successfully" }, "details": [ { "certtype": "Domain", "certificateTemplate": "N/A", "endpoint": { "hostName": "*.zoho.com", "port": "443", "expiry_date": "2021-04-30 05:29:59.0", "from_date": "2019-07-02 05:30:00.0", "certSignAlg": "SHA256withRSA", "Sans": "*.zoho.com,zoho.com", "serial": "8c0b04e91a1796d86d1de5e89c8b3c5c", "fingerPrint": "aeecb6227dc8adef18a8fb99465739996e2782a8", "keyalg": "RSA", "PublicKeyLength": 2048, "PrivateKey": false, "isAWS": false }, "isCertInstalledMulipleServers": false, "issuer": { "cname": "Sectigo RSA Domain Validation Secure Server CA", "org": "Sectigo Limited", "orgunit": "-" }, "issuedto": { "cname": "*.zoho.com", "org": "-", "orgunit": "Domain Control Validated" }, "intermediate": {}, "ipaddress": "204.141.32.155", "CertificateId": "302" } ] }
36. 証明書鍵ストアの取得
説明
特定の証明書の鍵ストアファイルの取得方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getCertificateKeyStore
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
GET
入力データ
操作の名称と鍵ストアファイルのコモンネームは入力として渡される必要があります。
{ "operation" : {
"Details" : {
"common_name" : "apitest", "serial_number":"XXXXXXXXXXXXXX" //optional to provide serial number to fetch the keystore file }
} }
リクエスト例
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/getCertificateKeyStore?INPUT_DATA={"operation":{"Details":{"common_name":"apitest","serial_number":"XXXXXXXXXXXXXX"}}}
レスポンス例
KeyStore File Object
37. 証明書のパスフレーズを取得
URL
https://< Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getCertificatePassphrase
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
GET
入力データ
次のデータを入力として渡す必要があります。
{"operation":{"Details":{"common_name":"mycert","serial_number":"XXXXXXXXXXXXXX"}}}
リクエスト例
https://< Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/getCertificatePassphrase?INPUT_DATA={"operation":{"Details":{"common_name":"mycert","serial_number":"XXXXXXXXXXXXXX"}}}
レスポンス例
{ "name": "GetCertificatePassphrase", "result": { "status": "Success", "message": "Private key passphrase of certificate mycert is 123456789" } }
38. 証明書の追加
PMPの証明書レポジトリに証明書を追加する方法
URL
https://< Host-Name-of-PMP-Server OR IP address >:<Port>/api/pki/restapi/addCertificate
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
入力データ
次のデータは入力として渡される必要があります。
input data: {"operation":{"Details":{"fileType":"KEYSTORE","PASSWORD":"PASSWORD"}}}
注意: 入力データで指定されたfileTypeはCERTFILE、またはKEYSTOREのいずれかである必要があります。CERTFILE fileTypeの場合、PASSWORDフィールドは指定する必要はありません。
リクエスト例
curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>> " -H 'Content-Type: multipart/form-data' -F INPUT_DATA={"operation":{"Details":{"fileType":"KEYSTORE","PASSWORD":"PASSWORD"}}} -F File=@D:/certs/newcert.keystore https://< Host-Name-of-PMP-Server OR IP address >:<Port>/api/pki/restapi/addCertificate
レスポンス例
{
"name": "AddCertificate",
"result":
{{"Status":"Success",
"Message": "Certificate newcert.com added successfully"}
}
}
39. 証明書の削除
説明
PMPの証明書レポジトリから証明書を削除する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/deleteCertificate
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
DELETE
入力データ
操作の名称と証明書のコモンネームは入力として渡される必要があります。
{
"operation": {
"Details":{
"common_name" : "apitest",
"serial_number" : "XXXXXXXXXXXXXX" //optional to provide serial number to delete a certificate
} } }
リクエスト例
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/deleteCertificate?INPUT_DATA={"operation": {"Details":{"common_name":"apitest","serial_number":"XXXXXXXXXXXXXX"}}}
レスポンス例
{"name":"DeleteCertificate","result":{"status":"Success","message":"Certificate apitest deleted successfully."}}
40. SSL証明書ディスカバリの実行
説明
特定のSSL証明書をディスカバリする方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/sslCertSingleDiscovery
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
入力データ
ホスト名やIPアドレス、ポート番号は入力として渡される必要があります。
{"operation":{"Details":{"HOST":"de-ubuntu10-1","TIMEOUT":"300","PORT":"<Port>"}}}
リクエスト例
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/sslCertSingleDiscovery?INPUT_DATA={"operation":{"Details":{"HOST":"de-ubuntu10-1","TIMEOUT":"300","PORT":"<Port>"}}}
レスポンス例
{ "name": "Get SSL Discovery", "totalRows": 1, "details": { "zoho.com": [ "SUCCESS", "SSL Certificate already available, *.zoho.com certificate found at port 443" ] } }
41. SSL証明書ディスカバリの実行 （IPアドレスの範囲）
説明
特定のSSL証明書セットをディスカバリする方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/sslCertRangeDiscovery
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
入力データ
{"operation":{"Details":{"StartIpAddress":"192.xxx.xxx.0",
"EndIpAddress":"192.xxx.xxx.3",
"TIMEOUT":"3",
"PORT":"443"}}}
リクエスト例
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/sslCertRangeDiscovery?INPUT_DATA={"operation":{"Details":{"StartIpAddress":"192.xxx.xxx.0","EndIpAddress":"192.xxx.xxx.3","TIMEOUT":"3","PORT":"443"}}}
レスポンス例
{ "name": "Get SSL Discovery", "totalRows": 4, "details": { "192.168.216.1": [ "FAILURE", "Connection failed,no certificate found at port 443" ], "192.168.216.0": [ "FAILURE", "Connection timed out,no certificate found at port 443" ], "192.168.216.2": [ "FAILURE", "Connection timed out,no certificate found at port 443" ], "192.168.216.3": [ "FAILURE", "Connection timed out,no certificate found at port 443" ] } }
42. CSRの作成
説明
証明書署名要求の作成
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/createCSR
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
入力データ
次のデータは入力として渡される必要があります。
{"operation":{"Details":{"CNAME":"mytestcert",
"ALT_NAMES":"test",
"ORGUNIT":"zohocorp",
"ORG":"manageengine",
"LOCATION":"chennai",
"STATE":"Tamilnadu",
"COUNTRY":"IN",
"PASSWORD":"zohocorp",
"VALIDITY":"888",
"VALIDITY_TYPE":"days",
"ALG":"RSA",
"LEN":"4096",
"SIGALG":"SHA256",
"StoreType":"PKCS12"}}}
注意: 有効期限のタイプは、日、時間、または分です。
リクエスト例
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/createCSR?INPUT_DATA={"operation":{"Details":{"CNAME":"mytestcert", "ALT_NAMES":"test", "ORGUNIT":"zohocorp", "ORG":"manageengine", "LOCATION":"chennai", "STATE":"Tamilnadu","COUNTRY":"IN", "PASSWORD":"zohocorp", "VALIDITY":"888","VALIDITY_TYPE":"days", "ALG":"RSA", "LEN":"4096", "SIGALG":"SHA256", "StoreType":"PKCS12"}}}
レスポンス例
{ "name": "CreateCSR", "result": { "status": "Success", "message": "CSR saved successfully" }, "totalRows": 1, "details": [ { "CSR_ID": 602 } ] }
43. CSRリストの取得
説明
CSRリストの取得方法
HTTPSメソッド
GET
入力データ
INPUT_DATA={"operation":{"Details":{"common_name":"testcsr"}}} (optional)
注意: Without INPUT_DATA all the CSR will be fetched. But with INPUT_DATA, the CSR matching the common_name criteria alone will be fetched.
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
リクエスト例
https://<HostName>:7272/api/pki/restapi/getCSRList
レスポンス例
{ "name": "GetCSRList", "result": { "status": "Success", "message": "Fetched all CSRs successfully" }, "totalRows": 1, "details": [ { "CREATED_BY": "admin", "KEYALGORITHM": "RSA", "KEYSTORE_TYPE": "JKS", "isPassword": true, "CSR_ID": 1, "CREATED_DATE": "May 15, 2020 19:51", "LOGIN_ID": 301, "KEY_STRENGTH": 2048, "DOMAIN_NAME": "testcsr", "VALIDITY": "30", "SIGNATURE_ALGORITHM": "SHA256withRSA" } ] }
44. CSRへの署名
説明
CSRに証明する方法
HTTPSメソッド
POST
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
入力データ
INPUT_DATA={"operation":{"Details":{"serverName":"pmp-w12r2-1","caName":"pmp-w12r2-1-ca","templateName":"DomainController","CSR_ID":"1"}}}
リクエスト例
https://<HostName>:7272/api/pki/restapi/signCSR
レスポンス例
{"name":"SignCSR","result":{"status": "Success","message":"Successfully testdomain.com certificate signed"}}
45. SSL証明書の作成
説明
SSL証明書の作成方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/createCertificate
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
入力データ
次のデータは入力として渡される必要があります。
{"operation":{"Details":{"CNAME":"mytestcert",
"ALT_NAMES":"test",
"ORGUNIT":"zohocorp",
"ORG":"manageengine",
"LOCATION":"chennai",
"STATE":"Tamilnadu",
"COUNTRY":"IN",
"PASSWORD":"zohocorp",
"VALIDITY":"888",
"VALIDITY_TYPE":"days",
"ALG":"RSA",
"LEN":"4096",
"SIGALG":"SHA256",
"StoreType":"PKCS12"}}}
リクエスト例
https://<Host-Name-of-PMP-Server OR IP address>
レスポンス例
{"name":"CreateCertificate","result":{"status":"Success","message":"Certificate saved successfully"}}
46. ユーザーのIDを取得
説明
ユーザー名を渡してユーザーのIDを取得する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/getUserId
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
orgName= <<org display name>>
HTTPメソッド
GET
入力データ
なし
リクエスト例
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/getUserId?USERNAME=user1
レスポンス例
{
"operation": {
"name":"get_USERID",
"result": { "status":"Success","message":"User Id for the specified username have been
fetched successfully"},"Details":{"USERID":"1"}}}
47. ユーザー名を使用してユーザーの削除
説明
ユーザー名を使用してユーザーの削除する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user?USERNAME=(username)
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
orgName= <<org display name>>
HTTPメソッド
DELETE
入力データ
なし
リクエスト例
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user?USERNAME=admin1
レスポンス例
{"operation":{"name":"DELETE USER","result":{"status":"Success","message":"User admin1 deleted successfully"}}}
48. ユーザーをユーザーグループへ追加
説明
ユーザー名を渡してユーザーをユーザーグループに追加する方法、およびユーザー名が追加されるユーザーグループの追加方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/addUserToUserGroup?USERNAME=(username)&USERGROUPNAME=(usergroupname)
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
orgName= <<org display name>>
HTTPメソッド
POST
入力データ
なし
リクエスト例
https://<Host-Name-of-PMP-ServerORIP address>:<Port>/restapi/json/v1/user/addUserToUserGroup?=admin1&USERGROUPNAME=TestGroup
レスポンス例
{"operation":{"name":"ADD USER TO USERGROUP","result":{"status":"Success","message":"User admin1 added to User Group TestGroup successfully"}}}
49. ユーザーのロック
説明
ユーザー名を渡してユーザーをロックする方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/lock?USERNAME=(username)
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
orgName= <<org display name>>
HTTPメソッド
PUT
入力データ
なし
リクエスト例
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/lock?USERNAME=apiuser
レスポンス例
{"operation":{"name":"LOCK USER","result":{"status":"Success","message":"User account apiuser locked successfully."}}}
50. ユーザーのロック解除
説明
ユーザー名を渡してユーザーのロックを解除する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/unlock?USERNAME=(username)
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
orgName= <<org display name>>
HTTPメソッド
PUT
入力データ
なし
リクエスト例
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/unlock?USERNAME=apiuser
レスポンス例
{"operation":{"name":"UNLOCK USER","result":{"status":"Success","message":"User account apiuser unlocked successfully. "}}}
51. SSH鍵のインポート
説明
SSH鍵をインポートする方法
URL
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/addSSHKey
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
入力データ
次のデータは入力として渡される必要があります。
{
"operation":
{
"Details":
{
"keyName":"testkey","passphrase":"passtrix"
}
}
}
リクエスト例
curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H 'Content-Type: multipart/form-data' -F INPUT_DATA={"operation":{"Details":{"keyName":"testkey","passphrase":"passtrix"}}} -F File=@D:/certs/keys/test1-passtrix/test1_Jul-21-2017-15_56.key https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/addSSHKey
レスポンス例
{
"name":"addSSHKey","result":
{
"status":"SUCCESS","message":"Key imported successfully"
}
}
52. SSH鍵の関連付け
説明
SSH鍵を関連付けをする方法
URL
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/associateKey
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
入力データ
次のデータは入力としてパスされる必要があります。
{
"operation":
{
"Details":
{
"keyName":"testkey","resourceName":"test.csez.zohocorpin.com","userName":"test"
}
}
}
リクエスト例
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/associateKey?INPUT_DATA={"operation":{"Details":{"keyName":"testkey","resourceName":"test.csez.zohocorpin.com","userName":"test"}}}
レスポンス例
{
"name": "associateKey", "result":
{ "status": "Success", "message": "Key associated successfully"
}
}
53. SSH鍵の関連付けの解除
説明
SSH鍵の関連付けの解除方法
URL
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/dissociateKey
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
入力データ
次のデータは入力としてパスされる必要があります。
{
"operation":
{
"Details":
{
"keyName":"testkey","resourceName":"test.csez.zohocorpin.com","userName":"test"
}
}
}
リクエスト例
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/api/pki/restapi/dissociateKey?INPUT_DATA={"operation":{"Details":{"keyName":"testkey","resourceName":"test.csez.zohocorpin.com","userName":"test"}}}
レスポンス例
{
"name": "dissociateKey", "result":
{
"status": "SUCCESS", "message": "Key dissociated successfully."
}
}
54. 動的リソースグループの作成
説明
PMPで動的リソースグループを作成する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
入力データ
次のデータは入力として渡される必要があります。
{
"operation": {
"Details": {
"critgroup": "CG1",
"critdesc": "description about CG1",
"RuleCriteria": "Low",
"NoHelpDeskRetrieval": "false",
"andor": "and",
"NoOfCriteria": 2,
"condition_1": "RESOURCENAME",
"operator_1": "CONTAINS",
"valuefield_1": "win",
"condition_2": "LOGINNAME",
"operator_2": "CONTAINS",
"valuefield_2": "PMP"
}
}
}
リクエスト例
curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PMP>>" -H "Content-Type: text/json"
'https://192.xxx.xxx.29:<Port>/restapi/json/v1/resourcegroup -d
'INPUT_DATA={
"operation": {
"Details": {
"critgroup": "CG1",
"critdesc": "description about CG1",
"RuleCriteria": "Low",
"NoHelpDeskRetrieval": "false",
"andor": "and",
"NoOfCriteria": 2,
"condition_1": "RESOURCENAME",
"operator_1": "CONTAINS",
"valuefield_1": "win",
"condition_2": "LOGINNAME",
"operator_2": "CONTAINS",
"valuefield_2": "PMP"
}
}
}
出力サンプル
{
"operation":
{
"name":"CREATE RESOURCE GROUP",
"result":
{
"status":"Success",
"message":"Group CG1 has been added successfully."
}
}
}
55. 監査情報の取得
説明
PMPで監査情報を取得する方法
URL
https://<Host-Name-of-PMP-ServerORIPaddress>:<Port>/restapi/json/v1/audit?AUDITTYPE=<<Resource/User>>&STARTINDEX=&LIMIT=&DURATION=<<TODAY / YESTERDAY/ LAST_7_DAYS >>
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
GET
入力データ
なし
リクエスト例
https://localhost:<Port>/restapi/json/v1/audit?AUDITTYPE=Resource&STARTINDEX=1&LIMIT=2&DURATION=YESTERDAY
レスポンス例
{
"operation":
"name": "GET_AUDIT",
"result":
"status": "Success",
"message": "Audits fetched successfully."
},
"totalRows": 2,
"Details":
"AUDITID": "3002",
"RESOURCENAME": "Not Applicable",
"ACCOUNTNAME": "N/A",
"OPERATIONTYPE": "CI/CD Settings Updated",
"OPERATEDBY": "admin",
"IPADDRESS": "localhost",
"USERNAME": "N/A",
"LASTACCESSEDTIME": "2019-01-03 14:51:06.666",
"REASON": "Jenkins Authtoken Modified.",
"NAME": "N/A",
"CLIENT": "Web Client"
},
"AUDITID": "2113",
"RESOURCENAME": "test",
"ACCOUNTNAME": "test",
"OPERATIONTYPE": "Password Verification Failed",
"OPERATEDBY": "System",
"IPADDRESS": "localhost",
"USERNAME": "N/A",
"LASTACCESSEDTIME": "2019-01-03 01:45:00.107",
"REASON": "PMP could not verify the password integrity.",
"NAME": "N/A",
"CLIENT": "Web Client"
}
]
}
}
56. リソースをユーザーに共有する
説明
リソースをユーザーに共有する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<resourceid>/share
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
PUT
入力データ
{"operation": {"Details": {"ACCESSTYPE": "modify","USERID":"1" } } } Allowed accesstypes: view, modify, fullaccess, revoke
リクエスト例
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/1/share
レスポンス例
{ "operation": { "name": "SHARE RESOURCE","result": { "status":"Success","message":"Read and Modify permission granted to user successfully." } } }
57. アカウントをユーザーに共有
説明
アカウントをユーザーに共有する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<resourceid>/accounts/<accountid>/share
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
PUT
入力データ
{ "operation": { "Details": { "ACCESSTYPE":"modify","USERID":"1" } } } Allowed accesstypes: view, modify, revoke
リクエスト例
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/accounts/11/share
レスポンス例
{ "operation": { "name": "SHARE ACCOUNT","result": { "status":"Success","message":"View and Modify permission granted to user successfully." } } }
58. リソースをユーザーグループに共有
(このAPIは、PMPビルド11105以降でのみ動作します。)説明
リソースをユーザーグループに共有する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<resourceid>/share
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
orgName= <<org display name>>
HTTPメソッド
PUT
入力データ
INPUT_DATA={"operation":{"Details":{"ACCESSTYPE":"view","USERGROUPID":"1"}}}
Allowed accesstypes: view, modify, fullaccess, revoke
リクエスト例
レスポンス例
{ "operation": { "result": { "message": "Read Only permission granted to user group(s) successfully.", "status": "Success" }, "name": "SHARE RESOURCE" } }
59. アカウントをユーザーグループに共有
(このAPIは、PMPビルド11105以降でのみ動作します。)説明
アカウントをユーザーグループに共有する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<resourceid>/accounts/<accountid>/share
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
orgName= <<org display name>>
HTTPメソッド
PUT
入力データ
INPUT_DATA={"operation":{"Details":{"ACCESSTYPE":"view","USERGROUPID":"1"}}}
Allowed accesstypes: view, modify, fullaccess, revoke
リクエスト例
レスポンス例
{ "operation": { "result": { "message": "Read Only permission granted to user group(s) successfully.", "status": "Success" }, "name": "SHARE ACCOUNT" } }
60. ユーザーグループIDの取得
(This API works from PMP build 11105 and above only)説明
ユーザーグループのIDを取得する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/getUserGroupId?USERGROUPNAME=<usergroupname>
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
orgName= <<org display name>>
HTTPメソッド
GET
リクエスト例
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/getUserGroupId?USERGROUPNAME=<usergroupname>
レスポンス例
{"operation":{"name":"GET_USERGROUPID","result":{"status":"Success","message":"Usergroup Id for the specified usergroup name have been fetched successfully. "},"Details":{"USERGROUPID":"1"}}}
61. Linuxリソースのパスワード変更用の資格情報を設定
(このAPIは、PMPビルド11105以降でのみ動作します。)説明
Linuxリソースのパスワード変更用の資格情報を設定する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/configureremotepasswordreset
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
POST
入力データ
{"operation": {"Details": {
"REMOTEMODE":"ssh|telnet", // Default value - ssh
"LINUX_SSHTELNETPORT":"22",
"LINUX_USERPROMPT":"$",
"LINUX_LANDINGSERVER":"test",
"RESOURCEIDENTIFIER":"linux | others", // Default value - linux
"WDRESOURCEID":"1",
"WDACCOUNTID":"1",
"REMOTELOGINACCOUNT":"",
"AUTHENTICATION":"passauth | keyauth", // Default value -passauth
"ELEVATIONTYPE":"su | sudo", // Default value - sudo
"ROOTACCOUNT":"root",
"LINUXROOTUSERPROMPT":"#",
"RESOURCEIDS":["301","302","601"],
"RESOURCETYPE":"Linux",
"REMOVEENTER":"true | false" // Default value - false}}}
リクエスト例
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/configureremotepasswordreset
レスポンス例
{"operation":{"result":{
"message": "Password reset details configured for the matching resources.",
"status": "Success"},"Details":{
"CONFIGURATION RESULT":[{
"STATUS": "SUCCESS",
"RESOURCENAME": "pmp-os1.win.domain.com",
"RESOURCEID": "3"},{
"STATUS": "SUCCESS",
"RESOURCENAME": "DC-u16.lin.domain.com",
"RESOURCEID": "4"}]},
"name": "CONFIGURE REMOTE PASSWORD RESET"}}
62. SSL証明書のデプロイ
(このAPIは、PMPビルド11300以降でのみ動作します。)
説明
SSL証明書をデプロイする方法。
HTTPメソッド
POST
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
入力データ
INPUT_DATA={"operation":{"Details":{"common_name":"testcert","serial_number":"xxxxxxxx","serverName":"testmachine"}}}
Note: It is optional to provide the server name. The server name allows you to deploy certificates to that particular server. Without the server name, the certificates are deployed to all the saved servers from the client.
リクエスト例
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/deployCertificate
レスポンス例
{"result": {
"message": "Certificate deployment is successful.",
"status": "Success"
},
"name": "DeployCertificate",
"totalRows": 1,
"deployStatus": [
{
"server": "testmachine",
"message": "Certificate testcert of format CER and PFX deployed in testmachine successfully.",
"status": "Success"
}]}
63. ユーザーにSSL証明書を共有する
(このAPIは、PMPビルド11300以降でのみ動作します。)
説明
ユーザーにSSL証明書を共有する方法。
HTTPメソッド
POST
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/shareCertificateToUser
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
入力データ
INPUT_DATA:{"operation":{"Details":{ "common_name":"certificate","serial_number":"179ae1f45a8" ,"userId":"301"}}}
レスポンス例
"message": "Certificate shared successfully.",
"status": "Success"
}, "name": "ShareCertificate"}
64. ユーザーグループにSSL証明書を共有する
(このAPIは、PMPビルド11300以降でのみ動作します。)
説明
ユーザーグループにSSL証明書を共有する方法。
HTTPメソッド
POST
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/shareCertificateToUserGroup
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
入力データ
INPUT_DATA:{"operation":{"Details":{ "common_name":"certificate","serial_number":"179ae1f45a8" ,"userGroupId":"301"}}}
レスポンス例
{ "result": { "message": "Certificate shared successfully.", "status": "Success" }, "name": "ShareCertificate" }
65. ユーザーにSSL証明書グループを共有する
(このAPIは、PMPビルド11300以降でのみ動作します。)
説明
ユーザーにSSL証明書グループを共有する方法。
HTTPメソッド
POST
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/shareCertificateGroupToUser
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
入力データ
INPUT_DATA:{"operation":{"Details":{ "certificate_group_name":"certificate" ,"userId":"301"}}}
レスポンス例
{ "result": { "message": "Certificate shared successfully.", "status": "Success" }, "name": "ShareCertificate" }
66. ユーザーグループにSSL証明書グループを共有する
(このAPIは、PMPビルド11300以降でのみ動作します。)
説明
ユーザーグループにSSL証明書グループを共有する方法。
HTTPメソッド
POST
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/shareCertificateGroupToUserGroup
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
入力データ
INPUT_DATA:{"operation":{"Details":{ "certificate_group_name":"certificate" ,"userGroupId":"301"}}}
レスポンス例
{ "result": { "message": "Certificate shared successfully.", "status": "Success" }, "name": "ShareCertificate" }
67. ユーザーからSSL証明書を剥奪する
(このAPIは、PMPビルド11300以降でのみ動作します。)
説明
ユーザーからSSL証明書を剥奪する方法。
HTTPメソッド
POST
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/revokeCertificateFromUser
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
入力データ
INPUT_DATA:{"operation":{"Details":{ "common_name":"certificate","serial_number":"179ae1f45a8" ,"userId":"301"}}}
レスポンス例
{ "result": { "message": "Access to certificate revoked successfully.", "status": "Success" }, "name": "RevokeCertificate" }
68. ユーザーグループからSSL証明書を剥奪する
(このAPIは、PMPビルド11300以降でのみ動作します。)
説明
ユーザーグループからSSL証明書を剥奪する方法。
HTTPメソッド
POST
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/revokeCertificateFromUserGroup
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
入力データ
INPUT_DATA:{"operation":{"Details":{ "common_name":"certificate","serial_number":"179ae1f45a8" ,"userGroupId":"301"}}}
レスポンス例
{ "result": { "message": "Access to certificate revoked successfully.", "status": "Success" }, "name": "RevokeCertificate" }
69. ユーザーからSSL証明書グループを剥奪する
(このAPIは、PMPビルド11300以降でのみ動作します。)
説明
ユーザーからSSL証明書グループを剥奪する方法。
HTTPメソッド
POST
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/revokeCertificateGroupFromUser
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
入力データ
INPUT_DATA:{"operation":{"Details":{ "certificate_group_name":"certificate" ,"userId":"301"}}}
レスポンス例
{ "result": { "message": "Access to certificate revoked successfully.", "status": "Success" }, "name": "RevokeCertificate" }
70. ユーザーグループからSSL証明書グループを剥奪する
(このAPIは、PMPビルド11300以降でのみ動作します。)
説明
ユーザーグループからSSL証明書グループを剥奪する方法。
HTTPメソッド
POST
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/revokeCertificateGroupFromUserGroup
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
入力データ
INPUT_DATA:{"operation":{"Details":{ "certificate_group_name":"certificate" ,"userGroupId":"301"}}}
レスポンス例
{ "result": { "message": "Access to certificate revoked successfully.", "status": "Success" }, "name": "RevokeCertificate" }
71. SSL証明書グループを作成する
(このAPIは、PMPビルド11300以降でのみ動作します。)
説明
SSL証明書グループを作成する方法。
HTTPメソッド
POST
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/createCertificateGroup
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
入力データ
INPUT_DATA={"operation":{"Details":{ "group_name":"NAME","group_description":"This is the description for the group certificate","group_mail":"pmp@zohocorporation.com","ssl_details":"301,202"}}}
レスポンス例
{"result":{"message":"Certificate group added successfully.","status":"Success"},"name":"createCertificateGroup"}
72. SSL証明書グループを削除する
(このAPIは、PMPビルド11300以降でのみ動作します。)
説明
SSL証明書グループを削除する方法。
HTTPメソッド
DELETE
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/deleteCertificateGroup
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
入力データ
INPUT_DATA={"operation":{"Details":{ "group_name":"NAME"}}}
レスポンス例
{"result":{"message":"The certificate group is deleted successfully.","status":"Success"},"name":"deleteCertificateGroup"}
73. SSL証明書グループを編集する
(このAPIは、PMPビルド11300以降でのみ動作します。)
説明
SSL証明書グループを編集する方法。
HTTPメソッド
POST
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/editCertificateGroup
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
入力データ
INPUT_DATA={"operation":{"Details":{ "group_name":"NEW NAME","group_description":"This is new description for the group certificate","group_mail":"pmp1@zohocorporation.com","ssl_details":"1,2,3"}}}
レスポンス例
{"result":{"message":"The certificate group is updated successfully.","status":"Success"},"name":"editCertificateGroup"}
74. エージェントインストール鍵を生成する
(このAPIは、PMPビルド11300以降でのみ動作します。)
説明
エージェントインストール鍵を生成する方法
HTTPメソッド
POST
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/api/pki/restapi/generateInstallKey
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
レスポンス例
{ "result": { "message": "Agent install key fetched successfully", "status": "Success" }, "name": "GetAgentInstallKey", "totalRows": 1, "AgentInstallKey": "20570b9e0ceaa936" }
75. パスワードポリシーの取得
(このAPIは、PMPビルド11300以降でのみ動作します。)
説明
組織内のすべてのパスワードポリシーを一覧表示する方法。
HTTPメソッド
GET
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/passwords/policies
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
orgName= <<org display name>>
レスポンス例
{ "operation":{ "result":{ "message": "Password Policies fetched successfully", "status": "Success" }, "Details":{ "ORGANIZATION": "CHAKRIORG", "POLICIES":[ { ENFORCE MIXED CASE": "false", " PASSWORD MAX LENGTH": "8", " ENFORCE SPL CHARS": "false", " POLICYNAME": "Low", " ENFORCE NUMERALS": "false", " NO OF SPL CHARS REQUIRED": "0", " DEFAULTPOLICY": "false", " CHECK DICTIONARY WORD": "false", " NUMBER OF LOWERCASE CHARACTERS REQUIRED": "0", " REUSE OF OLD PASSWORDS": "Don't allow last 1 passwords", " CHECK ANAGRAM OF LOGINNAME": "false", POLICYID": "10000000000001", CHECK SEQUENCE": "false", DESCRIPTION": "Password with less strict constraints", " ENFORCE STARTING WITH AN ALPHABET": "false", " CHECK REPEATED SUBSTRING": "false", " PASSWORD CAN CONTAIN LOGINNAME": "false", " NUMBER OF UPPERCASE CHARACTERS REQUIRED": "0", " CHECK SIMILARITY OF PASSWORDS": "false", " PASSWORD VALIDITY PERIOD": "0", " NUMBER OF NUMERALS": "0", " PASSWORD MIN LENGTH": "4" }, { " ENFORCE MIXED CASE": "true", " PASSWORD MAX LENGTH": "10", " ENFORCE SPL CHARS": "false", " POLICYNAME": "Medium", " ENFORCE NUMERALS": "true", " NO OF SPL CHARS REQUIRED": "0", " DEFAULTPOLICY": "false", " CHECK DICTIONARY WORD": "false", " NUMBER OF LOWERCASE CHARACTERS REQUIRED": "1", " REUSE OF OLD PASSWORDS": "Don't allow last 5 passwords", " CHECK ANAGRAM OF LOGINNAME": "false", " POLICYID": "10000000000002", " CHECK SEQUENCE": "false", " DESCRIPTION": "Password with few strict constraints", " ENFORCE STARTING WITH AN ALPHABET": "true", " CHECK REPEATED SUBSTRING": "false", " PASSWORD CAN CONTAIN LOGINNAME": "true", " NUMBER OF UPPERCASE CHARACTERS REQUIRED": "1", " CHECK SIMILARITY OF PASSWORDS": "true", " NUMBER OF PASSWORDS TO CHECK FOR SIMILARITY": "1", " PASSWORD VALIDITY PERIOD": "180", " NUMBER OF NUMERALS": "1", " PASSWORD MIN LENGTH": "6" }, { ENFORCE MIXED CASE": "true", " SEQUENCE LENGTH": "5", " PASSWORD MAX LENGTH": "16", " ENFORCE SPL CHARS": "true", POLICYNAME": "Strong", " ENFORCE NUMERALS": "true", " CHECK NUMERIC SEQUENCE": "true", " KEYBOARD LAYOUT": "QWERTY", " DESCRIPTION": "Password with strict constraints", " ENFORCE STARTING WITH AN ALPHABET": "true", " NUMBER OF PASSWORDS TO CHECK FOR SIMILARITY": "1", " PASSWORD VALIDITY PERIOD": "30", " DICTIONARY NAME": "Common Words", CHECK CONSECUTIVE SEQUENCE": "true", " NO OF SPL CHARS REQUIRED": "1", " DEFAULTPOLICY": "true", " CHECK DICTIONARY WORD": "true", " NUMBER OF LOWERCASE CHARACTERS REQUIRED": "1", " REUSE OF OLD PASSWORDS": "Don't allow last 10 passwords", " CHECK ANAGRAM OF LOGINNAME": "false", " CHECK ALPHABET SEQUENCE": "true", " POLICYID": "10000000000003", " CHECK KEYBOARD SEQUENCE": "true", " CHECK OBVIOUS SUBSTITUTION": "false", " CHECK SEQUENCE": "true", " CHECK REPEATED SUBSTRING": "true", " PASSWORD CAN CONTAIN LOGINNAME": "true", " NUMBER OF UPPERCASE CHARACTERS REQUIRED": "1", " CHECK SIMILARITY OF PASSWORDS": "true", " NUMBER OF NUMERALS": "1", " PASSWORD MIN LENGTH": "8" }, { " ENFORCE MIXED CASE": "true", " PASSWORD MAX LENGTH": "32", " ENFORCE SPL CHARS": "true", POLICYNAME": "Offline Password File", " ENFORCE NUMERALS": "true", " NO OF SPL CHARS REQUIRED": "1", " DEFAULTPOLICY": "false", " CHECK DICTIONARY WORD": "false", " NUMBER OF LOWERCASE CHARACTERS REQUIRED": "1", " REUSE OF OLD PASSWORDS": "Don't allow last 10 passwords", " CHECK ANAGRAM OF LOGINNAME": "false", " POLICYID": "10000000000004", " CHECK SEQUENCE": "false", " DESCRIPTION": "Policy for offline password access", " ENFORCE STARTING WITH AN ALPHABET": "false", " CHECK REPEATED SUBSTRING": "false", " PASSWORD CAN CONTAIN LOGINNAME": "true", " NUMBER OF UPPERCASE CHARACTERS REQUIRED": "1", " CHECK SIMILARITY OF PASSWORDS": "false", " PASSWORD VALIDITY PERIOD": "30", " NUMBER OF NUMERALS": "1", " PASSWORD MIN LENGTH": "16" }, { " ENFORCE MIXED CASE": "true", " SEQUENCE LENGTH": "3", " PASSWORD MAX LENGTH": "10", " ENFORCE SPL CHARS": "false", " POLICYNAME": "test", " ENFORCE NUMERALS": "true", " CHECK NUMERIC SEQUENCE": "true", " KEYBOARD LAYOUT": "QWERTY", " DESCRIPTION": "testing", " ENFORCE STARTING WITH AN ALPHABET": "true", " NUMBER OF PASSWORDS TO CHECK FOR SIMILARITY": "1", " PASSWORD VALIDITY PERIOD": "180", " DICTIONARY NAME": "Common Words", " CHECK CONSECUTIVE SEQUENCE": "false", " NO OF SPL CHARS REQUIRED": "0", " DEFAULTPOLICY": "false", " CHECK DICTIONARY WORD": "true", " NUMBER OF LOWERCASE CHARACTERS REQUIRED": "1", " REUSE OF OLD PASSWORDS": "Don't allow last 5 passwords", CHECK ANAGRAM OF LOGINNAME": "true", CHECK ALPHABET SEQUENCE": "true", " POLICYID": "10000000000011", " CHECK KEYBOARD SEQUENCE": "true", " CHECK OBVIOUS SUBSTITUTION": "true", " CHECK SEQUENCE": "true", " CHECK REPEATED SUBSTRING": "true", " PASSWORD CAN CONTAIN LOGINNAME": "true", " NUMBER OF UPPERCASE CHARACTERS REQUIRED": "1", " CHECK SIMILARITY OF PASSWORDS": "true", " NUMBER OF NUMERALS": "1", " PASSWORD MIN LENGTH": "6" } ] }, "name": "GET PASSWORD POLICIES" } }
76. リソース種別の取得
(このAPIは、PMPビルド11300以降でのみ動作します。)
説明
組織内のすべてのリソース種別を一覧表示する方法。
HTTPメソッド
GET
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/resourcetypes
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
orgName= <<org display name>>
入力データ
INPUT_DATA={ "operation":{ "Details":{ "RESOURCETYPE_CONTAINING":["brocade"], } } }
レスポンス例
{ "operation":{ "result":{ "message": "Resource Types fetched successfully", "status": "Success" }, "Details":{ "RESOURCETYPES":[ { "COMMAND_SET":[ "Brocade" ], "ISSYNCSUPPORTED": "false", "CUSTOMRESOURCETYPE": "Windows", "ISCERTIFICATE": "false", "CATEGORY": "network", "SYNCTYPE": "CustomCli", "ISPMPDEFAULTSUPPORTEDOSTYPE": "true", "OSID": "40", "RESOURCE_ATTRIBUTES":[ "DNS Name / IP Address", "Group Name", "Resource Description", "Department", "Resource URL", "Location", "Password Policy", "Resource Name" ], "ACCOUNT_ATTRIBUTES":[ "Password Policy", "Private Key", "Notes", "User Account", "User Account Password" ], "RESOURCETYPE": "Brocade", "DEFAULTRESOURCETYPE": "false" }, { "COMMAND_SET":[ "Brocade SAN Switch" ], "ISSYNCSUPPORTED": "false", "CUSTOMRESOURCETYPE": "Windows", "ISCERTIFICATE": "false", "CATEGORY": "network", "SYNCTYPE": "CustomCli", "ISPMPDEFAULTSUPPORTEDOSTYPE": "true", "OSID": "42", "RESOURCE_ATTRIBUTES":[ "DNS Name / IP Address", "Group Name", "Resource Description", "Department", "Resource URL", "Location", "Password Policy", "Resource Name" ], "ACCOUNT_ATTRIBUTES":[ "Password Policy", "Private Key", "Notes", "User Account", "User Account Password" ], "RESOURCETYPE": "Brocade SAN Switch", "DEFAULTRESOURCETYPE": "false" }, { "COMMAND_SET":["Brocade VDX"], "ISSYNCSUPPORTED": "false", "CUSTOMRESOURCETYPE": "Windows", "ISCERTIFICATE": "false", "CATEGORY": "network", "SYNCTYPE": "CustomCli", "ISPMPDEFAULTSUPPORTEDOSTYPE": "true", "OSID": "41", "RESOURCE_ATTRIBUTES":[ "DNS Name / IP Address", "Group Name", "Resource Description", "Department", "Resource URL", "Location", "Password Policy", "Resource Name" ], "ACCOUNT_ATTRIBUTES":[ "Password Policy", "Private Key", "Notes", "User Account", "User Account Password" ], "RESOURCETYPE": "Brocade VDX", "DEFAULTRESOURCETYPE": "false" } ], "ORGANIZATIONNAME": "MSPOrg" }, "name": "GET RESOURCE TYPES" } }
77. リソースをリソースグループに関連付ける
(このAPIは、PMPビルド12000以降でのみ動作します。)
説明
リソースをリソースグループに関連付ける方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup/<groupId>/associateResources
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
orgName= <<org display name>>
HTTPメソッド
POST
入力データ
{ "operation": {"Details": { RESOURCEIDS:[1, 2] }}}
リクエスト例
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup/<groupId>/associateResources
レスポンス例
{ "operation": { "result": { "message":"Resource added to group successfully.","status":"Success"}, "Details": { "1": { "status":"Success"}, "2":{ "status":"Success" }}, "name":"ASSOCIATE RESOURCES" }}
78. リソースグループからリソースの関連付けを解除する
(このAPIは、PMPビルド12000以降でのみ動作します。)
説明
リソースグループからリソースの関連付けを解除する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup/<groupId>/disassociateResources
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
orgName= <<org display name>>
HTTPメソッド
POST
入力データ
{ "operation": {"Details": { RESOURCEIDS:[1, 2] }}}
リクエスト例
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup/<groupId>/disassociateResources
レスポンス例
{ "operation": { "result": { "message":"Resource removed from group successfully.","status":"Success" }, "Details":{ "1":{ "status":"Success"}," 2":{ "status":"Success" }}, "name":"DISASSOCIATE RESOURCES" }}
79. リソースに関連付けられたリソースグループの取得
(このAPIは、PMPビルド12000以降でのみ動作します。)
説明
リソースに関連付けられたリソースグループの取得を行う方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<ResourceId>/associatedGroups
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
orgName= <<org display name>>
HTTPメソッド
GET
リクエスト例
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resources/<ResourceId>/associatedGroups
レスポンス例
{ "operation": { "result":{ "message":"Associated groups fetched successfully","status":"Success"}, "Details":{ "ASSOCIATED GROUPS":[{ "GROUP ID":301,"GROUP NAME":"Default Group"}]}, "name":"GET ASSOCIATED GROUPS" }}
80. リソースグループの削除
(このAPIは、PMPビルド12000以降でのみ動作します。)
説明
特定のリソースグループを削除する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup?RESOURCEGROUPID=<resourcegroupid>
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
orgName= <<org display name>>
HTTPメソッド
DELETE
リクエスト例
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup?RESOURCEGROUPID=<resourcegroupid>
レスポンス例
{ "operation":{ "name":"DELETE RESOURCE GROUP","result": { "status":"Success","message":"Resource Group deleted successfully." }}}
81. リソースグループIDの取得
(このAPIは、PMPビルド12000以降でのみ動作します。)
説明
リソースグループのIDを取得する方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup/getResourceGroupId?RESOURCEGROUPNAME=<resourcegroupname>&USERID=<userid>
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
GET
入力データ
RESOURCEGROUPNAME=<resourcegroupname> USERID=<userid>
リクエスト例
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup/getResourceGroupId?RESOURCEGROUPNAME=<resourcegroupname>&USERID=<userid>
レスポンス例
{ "operation":{ "name":"GET RESOURCE GROUP ID","result": { "status":"Success","message":"Resource Group Id for the specified Resource Group name have been fetched successfully."} ,"Details":{"RESOURCEGROUPID":"1" }}}
82. 2段階認証のリセット
(このAPIは、PMPビルド12000以降でのみ動作します。)
説明
ユーザーの2段階認証をリセットする方法
URL
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/resetMFA?USERNAME=<username>
ヘッダー
AUTHTOKEN=<<Authtoken_generated_from_PMP>>
HTTPメソッド
PUT
パラメーター
USERNAME=<username>
リクエスト例
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup/getResourceGroupId?RESOURCEGROUPNAME=<resourcegroupname>&USERID=<userid>
レスポンス例
https://<Host-Name-of-PMP-Server OR IP address>:<Port>/restapi/json/v1/user/resetMFA?USERNAME=<username>
レスポンス例
{
"operation":{
"result":{
"message": "Two Factor Authentication reset successfully",
"status": "Success"
},
"name": "Reset MFA"
}
}