RESTful API

序章

PAM360 APIでは、PAM360と直接、接続、インタラクションおよび統合できます。APIはREpresentational State Transfer(REST)カテゴリに属します。PAM360 APIは、GET、PUT、およびPOSTメソッドを使って、リソースの作成やアカウントの追加、SSL証明書とSSHキーの追加、SSHキーのリソースとの関連づけ、リソース/アカウント詳細の取り込み、パスワードのプログラムによる更新、リソース/アカウントのユーザーとの共有等、幅広い操作ができます。

前提条件

APIユーザーアカウントの作成が、アプリケーション・ツー・アプリケーションパスワード管理にRestAPIを構成するプロセスでの最初の手順です。ここをクリックして、APIユーザーアカウントの作成方法についての詳細を確認します。

API要約

APIの呼び出しに使うメソッド

GET

リソース、アカウント、パスワード、アカウント/リソース詳細を取り込む

PUT

パスワードを変更する

POST

新しいリソースとアカウント作成する

APIはどのように利用しますか？

APIの呼び出し

APIは、HTTP POST、GETおよびPUT要求から呼出できます。要求中のすべてのパラメーターは、フォームURLエンコードされる必要があります。APIのすべてについてAUTH トークンのパスが必要です。これは必須です。

サポートしている形式

PAM360は、下記のとおり、JSON形式とURL構造をサポートしています：

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

PAM360には、以下に対応する幅広いAPIがあります：

リソースをユーザーと所有および共有する
リソースの一部となるアカウントを取得する
アカウントの詳細を取得する
リソースの一部となるアカウントのパスワードを取得する
アカウントのパスワードを変更する
新しいリソースを作成する
アカウントIDとリソースIDを取得する
リソース名を使ってリソースIDを取得する
PAM360のリソースを削除する
管理者によるパスワード承認を要求する
パスワード要求のリストを取得する
パスワード要求を拒否する
パスワード要求を承認する
管理者が承認したパスワードにチェックインする
管理者が承認したパスワードをチェックアウトする
パスワードを生成する
新しいユーザーを作成する
リソースを編集する
個別リソースのアカウントを削除する
ライセンスキー、ファイル、デジタル証明書、ドキュメント、画像等を取得する。
個別リソースのアカウントを作成する
個別リソースのアカウントを編集する
ユーザーを削除する
APIユーザーを作成する
新しいSSHキーを作成する
SSHキーを削除する
すべてのSSHキーを取り込む
特定のSSHキーを取り込む
SSHキーをエクスポートする
SSHキーを個別キータイプとしてエクスポートする
ユーザーにSSHキーを取得する
すべての関連づけられたユーザーを取り込む
SSL証明書を取得する
証明書を別のファイル形式で取得する
すべてのSSL証明書を取得する
すべてのSSL証明書の有効期限を取得する
SSL証明書詳細を取得する
SSL証明書キーストアを取得する
SSL証明書パスフレーズを取得する
SSL証明書を追加する
SSL証明書を削除する
SSL証明書検出を実行する
SSL証明書検出(幅広いIPアドレスの)を実行する
CSRを作成する
CSRリストを作成する
CSRに署名する
SSL証明書を作成する
ユーザーのIDを取得する
ユーザー名でユーザー名を削除する
ユーザーをユーザーグループに追加する
ユーザーをロックする
ユーザーをロック解除する
SSHキーをインポートする
SSHキーを関連づける
SSHキーの関連づけを解除する
PGPキーを取り込む
スタティックとダイナミックリソースグループを作成する
監査詳細を取得する
リソースをユーザーと共有する
アカウントをユーザーと共有する
リソースをユーザーグループと共有する
アカウントをユーザーグループと共有する
ユーザーグループIDを取り込む
Linuxリソースにリモートパスワードリセットを構成する
SSL証明書を展開する
SSL証明書をユーザーと共有する
SSL証明書をユーザーグループと共有する
SSL証明書グループをユーザーと共有する
SSL証明書グループをユーザーグループと共有する
ユーザーのSSL証明書を取り消す
ユーザーグループのSSL証明書を取り消す
ユーザーのSSL証明書グループを取り消す
ユーザーグループのSSL証明書を取り消す
SSL証明書グループを作成する
SSL証明書グループを削除する
SSL証明書グループを編集する
SSLエージェントインストールキーを生成する
パスワードポリシーを取得する
すべてのリソースの種類を取得する
リソースをリソースグループに関連づける
リソースをリソースグループから関連づけ解除する
リソースに関連づけられたリソースグループを取り込む
リソースグループを削除する
リソースグループIDを取り込む
二要素認証をリセットする
すべてのリソースグループを取り込む
パスワードバリデーター
ユーザーのグループを削除する
PAM360エージェントキーを生成および取り込む
HAステータスを取り込む
ユーザーグループからユーザーを削除する
すべてのユーザーを取り込む
すべてのユーザーグループを取り込む
リソースグループをユーザーに一括で共有すうｒ
リソースグループをユーザーグループに一括で共有する
リソースをユーザーに一括で共有する
リソースをユーザーグループに一括で共有する
アカウントをユーザーに一括で共有する
アカウントをユーザーグループに一括で共有する
すべての関連づけられたリモートアプリIDを取り込む
組織詳細を取得する

メモ：PAM360 ServerへのAPI呼出にはそれぞれ、認証トークン(AUTHTOKEN)を要求ヘッダonly.のみにパスする必要がありますので、注意してください。

1.リソースをユーザーと所有および共有する

説明

APIユーザーが所有または共有するリソースのリストを取得する。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>
orgName= <<org display name>>

HTTPメソッド

GET

入力データ

なし

サンプル要求

curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PAM360>>"https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources

サンプル出力

出力（下のサンプルで表示）で、個別APIユーザーが所有および共有するリソースをすべて取得します。

{
"operation":{
"result":{
"message":"Resource Windows Server has been added successfully",
"status": "Success"
}
"Details":[
{
"RESOURCE DESCRIPTION": "",
"RESOURCE TYPE": "WindowsDomain",
"RESOURCE ID": "303",
"RESOURCE NAME": "pmp2k16",
"NOOFACCOUNTS": "1",
"DNS NAME":"localhost"
}
],
"name": "GET RESOURCES",
"totalRows": 1
}
}

2.リソースの一部となるアカウントを取得する

説明

リソースにあるアカウントとリソース詳細のリストを取得する。リソースIDはGET RESOURCES API(上で説明)から取得できます。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

GET

入力データ

なし

サンプル要求

curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PAM360>>"https://<Host-Name-of-PAM360-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" } } } } }

注記：パスワードアクセスコントロールを有効にし、かつパスワードステータスが「使用中」の場合、出力は［使用中］と表示されます。

3.アカウントの詳細を取得する

説明

リソースの一部となるアカウントの詳細を取得するには、リソースIDとアカウントIDの両方をパスし、必要な詳細を取り込む必要があります。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

GET

入力データ

なし

サンプル要求

curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PAM360>>"https://<Host-Name-of-PAM360-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-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>/password

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

GET

入力データ

お使いの設定でパスワードを取り込む理由が求められる場合、以下の詳細を入力値としてパスする必要があります。発券システムが有効な場合、チケットIDを認証のためパスする必要があります。

INPUT_DATA={"operation":{"Details":{"REASON":"Need the password to Login Windows Server","TICKETID":"7"}}}

サンプル要求

curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PAM360>>"https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/303/accounts/307/password

curl -X GET -k -H "Content-Type: text/json" -H "AUTHTOKEN:<<Authtoken_generated_from_PAM360>>" https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/2/accounts/2/password --data-urlencode INPUT_DATA={"operation":{"Details":{"REASON":"Need the password to Login Windows Server"}}}

サンプル出力

{ "operation":{ "name":"GET PASSWORD", "result":{ "status": "Success", "message":"Password fetched successfully" },
"Details":{ "PASSWORD":"fqxdB7ded@4" } } }

注記：パスワードの取り込み時に問題が発生した場合、メッセージの一部としてその理由が表示されます。

5.アカウントのパスワードを変更する

説明

リソースの一部となるアカウントのパスワードを変更するには、リソースIDとアカウントIDの両方をパスし、必要な詳細を取り込む必要があります。発券システムが有効な場合、チケットIDを認証のためパスする必要があります。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>/password

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

PUT

入力データ

新しいパスワード、リセットタイプおよび理由等、入力データをパスする必要があります。リセットタイプはローカルまたはリモートのいずれかになります。

INPUT_DATA={
"operation":{
"Details":{
"NEWPASSWORD":"Test@12345$",
"RESETTYPE":"LOCAL",
"REASON":"Password Expired",
"TICKETID":"7"
} } }

サンプル要求

curl -X PUT -k -H "AUTHTOKEN<<Authtoken_generated_from_PAM360>>" https:/<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/2/accounts/2/password --data-urlencode INPUT_DATA={"operation":{"Details":{"NEWPASSWORD":"Test12345$","RESETTYPE":"LOCAL","REASON":"test","TICKETID":"7"}}}

サンプル出力

{"operation":{"name":"CHANGE PASSWORD","result":{"status":"Success","message":"Password changed successfully" } } }

注記：パスワードの変更時に問題が発生した場合、メッセージの一部としてその理由が表示されます。

6.新しいリソースを作成する

説明

新しいリソースをPAM360に作成するには.

入力データ

リソース名、アカウント名、リソースの種類、パスワード、URL、説明、メモおよびリソースおよびアカウントレベルの種類その他追加フィールド等の入力データをパスする必要があります。カスタムフィールドは40(各リソースおよびアカウントレベルで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-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

POST

サンプル要求

curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PAM360>>" -H "content-Type: text/json" https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources --data-urlencode "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" } ] } } }

注記：ファイルを個別リソースとしてPAM360に追加することもできます。ファイルを新しいリソースとして追加するには、要求の'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 "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-PAM360-Server OR IP address>ort>/ restapi/json/v1/resources?AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

7.アカウントIDとリソースIDを取得する

説明

アカウントIDとリソースIDを取得するには、リソース名とアカウント名をURLにパスする必要があります。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/getResourceIdAccountId? RESOURCENAME=(Resourcename)&ACCOUNTNAME=(Account name)

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

GET

入力データ

なし

サンプル要求

curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PAM360>>" "https://<Host-Name-of-PAM360-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-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/resourcename/{RESOURCENAME}

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

GET

入力データ

なし

サンプル要求

curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PAM360>>"https://<Host-Name-of-PAM360-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.PAM360のリソースを削除する

説明

指定されたリソースIDのリソースを削除します。リソースIDはGET RESOURCES API(上で説明)から取得できます。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/{resourceid}

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

削除

入力データ

なし

サンプル要求

curl -X DELETE -k -H "AUTHTOKEN:<<Authtoken_generated_from_PAM360>>" https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/2

サンプル出力

{ "operation":{ "name":"DELETE RESOURCE" "result":{"status":"Success" "message":"Resources deleted successfully."} }

10。管理者によるパスワード承認を要求する

説明

パスワードアクセス承認を管理者に要求する方法。アカウントidをURLのものにパスする必要があります。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/accounts/{accountid}/requestpassword

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

POST

入力データ

お使いの設定でパスワードを要求する理由の入力が求められる場合、以下の詳細を入力値としてパスする必要があります。

サンプル入力

INPUT_DATA={ "operation":{ "Details":{ PASSWDID":"1" "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。パスワード要求のリストを取得する

説明

ログインしている管理者が承認または拒否するパスワード要求のリストを取得する方法。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/accounts/passwordaccessrequests

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

GET

サンプル入力

INPUT_DATA= { "operation" : { "Details" : { "REASON" : "Testing", "TICKETID" : "7"}}}

サンプル要求

curl -k -H "AUTHTOKEN:<<Authtoken_generated_from_PAM360>>"https://<Host-Name-of-PAM360-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 PAM360 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 PAM360 server".
} ] } } }

注記：要求者IDは、そのパスワードを要求したユーザーのIDと同じです。

12。パスワード要求を拒否する

説明

管理者がパスワード要求を拒否する方法。これには、アカウントIDと要求者IDをURLにパスする必要があります。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/accounts/{accountid}/requester/{requesterid}/reject

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

POST

サンプル入力

INPUT_DATA={ "operation":{ "Details":{ "PASSWDID":"1" "REQUESTEDID" : "2" (userid of the request raised user) } } }

注記：要求者IDは、そのパスワードを要求したユーザーのIDと同じです。

サンプル要求

curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PAM360>>" -H "Content-Type: text/json"https://<Host-Name-of-PAM360-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。パスワード要求を承認する

説明

管理者がパスワード要求を承認する方法。ここでは、アカウントIDと要求者IDをURLにパスする必要があります。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/accounts/{accountid}/requester/{requesterid}/approve

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

POST

入力データ

なし

注記：要求者IDは、そのパスワードを要求したユーザーのIDと同じです。要求されたIDは、GET PASSWORDREQUEST API(REQUESTER USERID)で取得できます。

サンプル要求

サンプル出力

{ "operation" : { "name" : "ADMIN_REQUEST_APPROVE""result" : { "status" : "Success""message": "Password Approved successfully" } } }

14。管理者が承認したパスワードにチェックインする

説明

管理者が承認したパスワードにチェックインする方法。アカウントと要求者IDをその同じURLにパスする必要があります。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/accounts/{accountid}/requester/{requesterid}/checkin

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

POST

入力データ

INPUT_DATA={ "operation":{ "Details":{ "PASSWDID" : "1" "REQUESTEDID" : "2" (userid of the request raised user) } }

注記：要求者IDは、そのパスワードを要求したユーザーのIDと同じです。

サンプル要求

サンプル出力

{ "operation":{"name" : "ADMIN_REQUEST_CHECKIN""result" : {"status" : "Success""message" : "Password have been checked in successfully" } } }

15。管理者が承認したパスワードをチェックアウトする

説明

要求後、管理者が承認した後でパスワードをチェックアウトする方法。アカウントIDは、URLに同じものをパスする必要がありました。

URL

https://:<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/accounts/{accountid}/checkout

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

POST

入力データ

パスワードチェックアウトに理由が必要なカスタマイズされた設定のため、以下を入力としてパスする必要がらいます。

サンプル入力

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。パスワードを生成する

説明

PAM360の既存のポリシーを使ってパスワードを生成する方法。

URL

https:// <Host-Name-of-PAM360-Server OR IP address> :<Port>/restapi/json/v1/passwords/generate

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

GET

入力データ

INPUT_DATA={ "operation" : { "Details" : { "POLICY" : "Strong"}}}

サンプル出力

{ "operation": { "name": "GENERATE PASSWORD", "result": { "status": "Success", "message": "Password generated successfully." },
"Details": { "PASSWORD": "u%mdh7gfN" } } }

17。新しいユーザーを作成する

説明

新しいユーザーをPAM360に追加する。このAPIでは、パスワードを義務的に実行しなくとも、ユーザーを作成できます。

URL

https:// <Host-Name-of-PAM360-Server OR IP address> :<Port>/restapi/json/v1/user

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>
orgName= <<org display name>>

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":{
"result": {
"message": "User Created Successfully.",
"status": "Success",
},
"Details": {
"USERID": "302"
},
"name": "CREATE_USER"
}
}

18。リソースを編集

説明

リソースを編集する方法。

URL

https://severname:port/restapi/json/v1/resources/{RESOURCEID}

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

PUT

入力データ

(オプション入力は灰色表示されます)

サンプル入力

注記：リソースの種類を編集する場合、その特定リソースグループの値がある追加パラメーター"RESOURCETYPE"を入力に追加する必要があります。「リソースのスの種類」はキーストア、ライセンスストア、ラックスペース、およびAWS IAMから他のリソースの種類に変更できません。またその逆もできません。

INPUT_DATA={ "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_PAM360>>" https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/1 --data-urlencode "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-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>/

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

削除

サンプル要求

curl -X DELETE -k -H "AUTHTOKEN:<<Authtoken_generated_from_PAM360>>" -H "Content-Type: text/json" https://<Host-Name-of-PAM360-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-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>/downloadfile

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

GET

入力データ

お使いの設定でファイルをダウンロードする理由の入力が求められる場合、以下の詳細を入力値としてパスする必要があります。チケット発券システムが有効な場合、チケットIDを認証のためパスする必要があります。

INPUT_DATA={"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_PAM360>>"https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/1501/accounts/3601/downloadfile

21。個別リソースのアカウントを作成する

説明

個別リソースIDと関連づけられた複数のアカウントを作成します。

入力データ

アカウントリスト、アカウント名、パスワード、説明等の入力データをパスする必要があります。

パラメーターRECORD_RDP_SESSIONS、RECORD_CLI_SESSIONS、DISABLE_PASSWORD_RESETS、CONFIGURE_PASSWORD_RESET、ACCOUNT_RESOURCE_GROUP_IDS、IIS_WEB_CONFIG_RESET、IIS_APP_POOL_RESTART、IIS_APP_POOL_RESET、SERVICES_RESTART、SERVICES_RESETおよびSCHEDULED_TASK_RESETはビルド6000以降でのみ利用できます。

INPUT_DATA={
"operation":{
"Details":{
"ACCOUNTLIST": [
{
"ACCOUNTNAME":"bestest013",
"PASSWORD":"Pa$$Word@124",
"ACCOUNTPASSWORDPOLICY":"Strong",
"RECORD_RDP_SESSIONS":true,
"RECORD_CLI_SESSIONS":true,
"DISABLE_PASSWORD_RESETS":true,
"CONFIGURE_PASSWORD_RESET":true,
"ACCOUNT_RESOURCE_GROUP_IDS":["3002","3003"],
"IIS_WEB_CONFIG_RESET":true,
"IIS_APP_POOL_RESTART":true,
"IIS_APP_POOL_RESET":true,
"SERVICES_RESTART":true,
"SERVICES_RESET":true,
"SCHEDULED_TASK_RESET":true,
"NOTES":"IT Security - BES PAM API Test"
},
{
"ACCOUNTNAME":"bestest113",
"PASSWORD":"Pa$$Word@123",
"ACCOUNTPASSWORDPOLICY":"Strong",
"RECORD_RDP_SESSIONS":true,
"RECORD_CLI_SESSIONS":true,
"DISABLE_PASSWORD_RESETS":true,
"CONFIGURE_PASSWORD_RESET":true,
"ACCOUNT_RESOURCE_GROUP_IDS":["3002","3003"],
"IIS_WEB_CONFIG_RESET":true,
"IIS_APP_POOL_RESTART":true,
"IIS_APP_POOL_RESET":true,
"SERVICES_RESTART":true,
"SERVICES_RESET":true,
"SCHEDULED_TASK_RESET":true,
"NOTES":"IT Security - BES PAM API Test"
} ] } } }

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

POST

サンプル要求

curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PAM360>>" -H "Content-Type: text/json" https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/1/accounts --data-urlencode "INPUT_DATA={\"operation\":{ \"Details\":{ \"ACCOUNTLIST\": [{ \"ACCOUNTNAME\": \"bestest047\",\"PASSWORD\":\"Pa$$Word@123\",\"ACCOUNTPASSWORDPOLICY\":\"Strong\",\"NOTES\":\"IT Security - BES PAM360 API Test\"},{\"ACCOUNTNAME\":\"bestest048\", \"PASSWORD\":\"Pa$$Word@123\",\"ACCOUNTPASSWORDPOLICY\":\"Strong\",\"NOTES\":\"IT Security - BES PAM360 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-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/<Resource ID>/accounts/<Account ID>/

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

PUT

サンプル入力

INPUT_DATA=
{
"operation":{
"Details":{
"ACCOUNTNAME":"bestest013",
"ACCOUNTPASSWORDPOLICY":"Strong",
"RECORD_RDP_SESSIONS":true,
"RECORD_CLI_SESSIONS":true,
"DISABLE_PASSWORD_RESETS":true,
"CONFIGURE_PASSWORD_RESET":true,
"ACCOUNT_RESOURCE_GROUP_IDS":["3002","3003"],
"IIS_WEB_CONFIG_RESET":true,
"IIS_APP_POOL_RESTART":true,
"IIS_APP_POOL_RESET":true,
"SERVICES_RESTART":true,
"SERVICES_RESET":true,
"SCHEDULED_TASK_RESET":true,
"NOTES":"IT Security - BES PAM API Test"
}} }

サンプル要求

curl -X PUT -k -H "AUTHTOKEN:<<Authtoken_generated_from_PAM360>>" -H "Content-Type: text/json" https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/1/accounts/1 --data-urlencode "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-PAM360-Server OR IP address>:<Port>/restapi/json/v1/user/{userid}

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

削除

サンプル要求

curl -X DELETE -k -H "AUTHTOKEN:<<Authtoken_generated_from_PAM360>>" -H "Content-Type: text/json" https://<Host-Name-of-PAM360-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-PAM360-Server OR IP address> :<Port>/restapi/json/v1/user

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

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":"7DxxxAB-CAxxB-44xx5-8xx9-9317xxxxxEF0"}}}

25。新しいSSHキーを作成する

説明

新しいSSHキーを作成する。

URL

https:// <Host-Name-of-PAM360-Server OR IP address> :<Port>/api/pki/restapi/createsshkey

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

POST

入力データ

以下のデータを入力としてパスする必要があります：

{"operation":{"Details":{"keyName":"keytest",
"passPhrase":"passPhrase",
"comment":"comment",
"length":"2048",
"keyType":"ssh-rsa"}}}

サンプル要求

https://< Host-Name-of-PAM360-Server OR IP address >:<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キーを作成するのに使用できるキータイプです：

sh-rsa (キー長：1024/2048/4096)
ssh-dss (キー長：1024)
d25519 (個別キー長なし)
ecdsa (キー長：256/384/521)

26。SSHキーを削除する

説明

特定のSSHキーを作成する。

URL

https://< Host-Name-of-PAM360-Server OR IP address >:<Port>/api/pki/restapi/deleteSSHKey

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

削除

入力データ

以下のデータを入力としてパスする必要があります：

{"operation":{"Details":{"key_name":"newkey1","withoutDisassociation":"true"}}}

サンプル要求

https://< Host-Name-of-PAM360-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-PAM360-Server OR IP address>:<Port>/api/pki/restapi/getAllSSHKeys

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

GET

入力データ

なし

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<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-PAM360-Server OR IP address>:<Port>/api/pki/restapi/getSSHKey

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

POST

入力データ

入力としてパスする操作名とキー

{"operation":{"Details":{"keyName":"key"}}}

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<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-PAM360-Server OR IP address>:<Port>/api/pki/restapi/exportSSHKey

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

POST

入力データ

入力としてパスする必要がある操作名とキー。

{"operation":{"Details":{"keyName":"key"}}}

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/exportSSHKey?INPUT_DATA={"operation":{"Details":{"keyName":"key"}}}

サンプル応答

Key file

30。SSHキーを個別キータイプとしてエクスポート
(このAPIはPAM360ビルド6200以上のみで機能します)

説明

特定のSSHキーを個別キーエクスポートタイプとしてエクスポートする(公開または秘密)。

HTTPSメソッド

POST

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

入力データ

{"operation":{"Details":{"keyName":"Key","keyExportType":"public"}}}
{"operation":{"Details":{"keyName":"Key","keyExportType":"private"}}}

注記：「公開」または「秘密」を「keyExportType」で指定し、公開または秘密鍵を取り込むことを示します。

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/exportSSHKey?INPUT_DATA={"operation":{"Details":{"keyName":"Key","keyExportType":"public"}}}
https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/exportSSHKey?INPUT_DATA={"operation":{"Details":{"keyName":"Key","keyExportType":"private"}}}

サンプル応答

キーファイル

31。ユーザーにSSHキーを取得する

説明

特定のユーザーに関連づけられたすべてのSSHキーを取得します。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/getSSHkeysforuser

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

GET

入力データ

ユーザー名とリソース名を入力としてパスする必要があります。

{"operation":{"Details":{"userName":"test","resourceName":"172.21.xxx.xx"}}}

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<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 pam-centos6 fetched successfully" }, "details": "testkey,testkey1" }

32。すべての関連づけられたユーザーを取り込む

説明

SSHキーと関連づけられたすべてのユーザーを取り込みます。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/getAllAssociatedUsers

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

GET

入力データ

なし

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/getAllAssociatedUsers

サンプル応答

{ "name": "GetAllAssociatedUsers", "result": { "status": "Success", "message": "All associated users fetched successfully" }, "totalRows": 1, "details": [ { "UserName": "test", "ResourceName": "pam-centos6" } ] }

33。証明書を取得する

説明

証明書をPAM360の証明書リポジトリから取得する。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/getCertificate

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

GET

入力データ

操作の詳細と、取り込んだ証明書の名前を入力としてパスする必要があります。

{"operation": { "Details" : { "common_name" : "*.google.com","serial_number":"XXXXXXXXXXXXXX" // optional to provide serial number to fetch certificate details}}}

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/getCertificate?INPUT_DATA={"operation":{"Details":{"common_name":"*.google.com","serial_number":"XXXXXXXXXXXXXX"}}}

サンプル応答

Certificate object

34。証明書を別のファイル形式で取得する
(このAPIはPAM360ビルド6200以上のみで機能します)

説明

証明書をPAM360の証明書リポジトリで別のファイル形式で取得する。

HTTPSメソッド

GET

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

入力データ

操作の詳細と、取り込んだ証明書の名前を入力としてパスする必要があります

{"operation":{"Details":{"common_name":"certificate_common_name","serial_number":"certificate_serial_number,"fileType":"File format"}}}

注記：

証明書は、以下の形式でエクスポートできます：CER、CRT、DER、P7B、PKCS、JKS、PEM、KEY。

必要なファイル形式を「fileType」で指定し、その形式で証明書をエクスポートします。

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/getCertificate?INPUT_DATA={"operation":{"Details":{"common_name":"examplecert","serial_number":"182e967a976","fileType":"PEM"}}}

サンプル応答

証明書オブジェクト

35。すべての証明書を取得する

説明

すべての証明書をPAM360の証明書リポジトリから取得する。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/getAllSSLCertificates

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

GET

入力データ(オプション)

INPUT_DATA={"operation":{"Details":{"withExpiryDaysLessThan":"500","withKeyLength":"1024","withSignatureAlgorithm":"SHA1"}}}

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/getAllSSLCertificates?INPUT_DATA={"operation":{"Details":{"withExpiryDaysLessThan":"500","withKeyLength":"1024","withSignatureAlgorithm":"SHA1"}}}

サンプル応答

{ "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" } ] }

36。すべての証明書有効期限を取得する

説明

すべての証明書の有効期限日を取得する。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/getAllSSLCertsExpiryDate

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

GET

入力データ

なし

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<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" } ] }

37。証明書詳細を取得する

説明

特定の証明書の詳細を取得する。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/getCertificateDetails

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

GET

入力データ

操作の詳細と、証明書の名前を入力としてパスする必要があります。

{"operation": {"Details":{"common_name":"*.google.com"}}}

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<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" } ] }

38。証明書キーストアを取得する

説明

特定の証明書のキーストアファイルを取得する。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/getCertificateKeyStore

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

GET

入力データ

入力としてパスする必要がある操作名とキーストアファイルのコモンネーム。

{"operation" : { "Details" : {"common_name" : "apitest","serial_number":"XXXXXXXXXXXXXX" //optional to provide serial number to fetch the keystore file}}}

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/getCertificateKeyStore?INPUT_DATA={"operation":{"Details":{"common_name":"apitest","serial_number":"XXXXXXXXXXXXXX"}}}

サンプル応答

KeyStore File Object

39。証明書パスフレーズを取得する

証明書の秘密鍵パスフレーズを取得する。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/getCertificatePassphrase

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

GET

入力データ

以下のデータを入力としてパスする必要があります：

{"operation":{"Details":{"common_name":"mycert","serial_number":"XXXXXXXXXXXXXX"}}}

サンプル要求

https://<Host-Name-of-PAM360-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"}}

40。証明書を追加する

証明書をPAM360の証明書リポジトリに追加する。

URL

https://< Host-Name-of-PAM360-Server OR IP address >:<Port>/api/pki/restapi/addCertificate

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

POST

入力データ

以下のデータを入力としてパスする必要があります：

input data: {"operation":{"Details":{"fileType":"KEYSTORE","PASSWORD":"PASSWORD"}}}

Note: The fileType specified in the input data can be either CERTFILE or KEYSTORE. For CERTFILE fileType, the PASSWORD field need not be specified.

サンプル要求

curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PAM360>>" -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-PAM360-Server OR IP address >:<Port>/api/pki/restapi/addCertificate

サンプル応答

{ "name": "AddCertificate",
"result":
{{"Status":"Success",
"Message": "Certificate newcert.com added successfully"} } }

41。証明書を削除する

説明

証明書をPAM360の証明書リポジトリから削除する。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/deleteCertificate

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

削除

入力データ

操作の名前と証明書のコモンネームを入力としてパスする必要があります。

{"operation": {"Details":{"common_name" : "apitest","serial_number" : "XXXXXXXXXXXXXX" //optional to provide serial number to delete a certificate}}}

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/deleteCertificate?INPUT_DATA={"operation": {"Details":{"common_name":"apitest","serial_number":"XXXXXXXXXXXXXX" // optional to provide serial number to fetch certificate details}}}

サンプル応答

{"name":"DeleteCertificate","result":{"status":"Success","message":"Certificate apitest deleted successfully."}}

42。SSL証明書検出を実行する

説明

特定のSSL証明書を検出する。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/sslCertSingleDiscovery

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

POST

入力データ

ホストの名前/IPアドレスおよびポート番号を入力としてパスする必要があります。

{"operation":{"Details":{"HOST":"de-ubuntu10-1","TIMEOUT":"300","PORT":"<Port>"}}}

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<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" ] } }

43。SSL証明書検出(幅広いIPアドレスの)を実行する

説明

SSL証明書のセットを検出します。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/sslCertRangeDiscovery

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

POST

入力データ

開始と終了IPアドレス、ポート番号およびタイムアウトを入力としてパスする必要があります。

{"operation":{"Details":{"StartIpAddress":"192.xxx.xxx.x",
"EndIpAddress":"192.xxx.xxx.x",
"TIMEOUT":"3",
"PORT":"443"}}}

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<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" ] } }

44。CSRの作成

説明

証明書署名要求を作成します。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/createCSR

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

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-PAM360-Server OR IP address>:<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":"CreateCertificate","result":{"status":"Success","message":"CSR saved successfully"}}

45。CSRリストを作成する

説明

CSRリストを作成する

HTTPSメソッド

GET

入力データ

INPUT_DATA={"operation":{"Details":{"common_name":"testcsr"}}} (optional)

注記：INPUT_DATAがない場合、すべてのCSRを取り込まれます。ただし、INPUT_DATAでは、common_name基準と一致するCSRのみ取り込まれます。

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

サンプル要求

https://<HostName>:8282/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" } ] }

46。CSRに署名する

説明

CSRに署名する

HTTPSメソッド

POST

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

入力データ

INPUT_DATA={"operation":{"Details":{"serverName":"pam360-w12r2-1","caName":"pam360-w12r2-1-ca","templateName":"DomainController","CSR_ID":"1"}}}

サンプル要求

https://<HostName>:8282/api/pki/restapi/signCSR

サンプル応答

{"name":"SignCSR","result":{"status": "Success","message":"Successfully testdomain.com certificate signed"}}

47。証明書を作成

説明

SSL証明書を作成します。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/createCertificate

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

POST

入力データ

以下のデータを入力としてパスする必要があります：

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address> <Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/createCertificate?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":"CreateCertificate","result":{"status":"Success","message":"Certificate saved successfully"}}

48。ユーザーのIDを取得する

説明

ユーザー名をパスしてユーザーのIDを取得します。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/user/getUserId

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

orgName= <<org display name>>

HTTPメソッド

GET

入力データ

なし

サンプル要求

https://<Host-Name-of-PAM360-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"}}}

49。ユーザー名でユーザー名を削除する

説明

ユーザー名でユーザー名を削除します。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/user?USERNAME=(username)

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

orgName= <<org display name>>

HTTPメソッド

削除

入力データ

なし

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/user?USERNAME=admin1

サンプル応答

{"operation":{"name":"DELETE USER","result":{"status":"Success","message":"User admin1 deleted successfully"}}}

50。ユーザーをユーザーグループに追加する

説明

ユーザー名と追加先のユーザーグループをパスしてユーザーをユーザーグループに追加します。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/user/addUserToUserGroup?USERNAME=(username)&USERGROUPNAME=(usergroupname)

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>
orgName= <<org display name>>

HTTPメソッド

POST

入力データ

なし

サンプル要求

https://<Host-Name-of-PAM360-ServerORIP address>:<Port>/restapi/json/v1/user/addUserToUserGroup?USERNAME=admin1&USERGROUPNAME=TestGroup

サンプル応答

{"operation":{"name":"ADD USER TO USERGROUP","result":{"status":"Success","message":"User admin1 added to User Group TestGroup successfully"},"Details":{"USERGROUPID":"2"}}}

51。ユーザーをロックする

説明

ユーザー名をパスしてユーザー名をロックします。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/user/lock?USERNAME=(username)

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

orgName= <<org display name>>

HTTPメソッド

PUT

入力データ

なし

サンプル要求

https://<Host-Name-of-PAM360-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."}}}

52。ユーザーをロック解除する

説明

ユーザー名をパスしてユーザー名をロック解除します。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/user/unlock?USERNAME=(username)

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

orgName= <<org display name>>

HTTPメソッド

PUT

入力データ

なし

サンプル要求

https://<Host-Name-of-PAM360-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. "}}}

53。SSHキーをインポートする

説明

SSHキーをインポートします。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/addSSHKey

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

POST

入力データ

以下のデータを入力としてパスする必要があります：

{ "operation": { "Details": { "keyName":"testkey","passphrase":"passtrix" } } }

サンプル要求

curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PAM360>>" -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-PAM360-Server OR IP address>:<Port>/api/pki/restapi/addSSHKey

サンプル応答

{ "name":"addSSHKey","result": { "status":"SUCCESS","message":"Key imported successfully" } }

54。SSHキーを関連づける

説明

SSHキーを関連づけます。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/associateKey

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

POST

入力データ

以下のデータを入力としてパスする必要があります：

{ "operation": { "Details": { "keyName":"testkey","resourceName":"test.csez.zohocorpin.com","userName":"test" } } }

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<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" } }

55。SSHキーの関連づけを解除する

説明

SSHキーの関連づけを解除します。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/dissociateKey

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

POST

入力データ

以下のデータを入力としてパスする必要があります：

{ "operation": { "Details": { "keyName":"testkey","resourceName":"test.csez.zohocorpin.com","userName":"test" } } }

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<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." } }

56。PGPキーを取り込む
(このAPIはPAM360ビルド6200以上のみで機能します)

説明

PGPキーを取り込む

HTTPSメソッド

GET

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

入力データ

以下のデータを入力としてパスする必要があります：

{"operation":{"Details":{"User":"test (test) <tes@test.com>","keyExportType":"public"}}}
{"operation":{"Details":{"User":"test (test) <tes@test.com>","keyExportType":"private"}}}

注記：

「公開」または「秘密」を「keyExportType」で指定し、公開または秘密鍵を取り込むことを示します。
キー「User」の特殊文字を使用している場合、バックラッシュを使ってエスケープしてください。

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/getPGPKey?INPUT_DATA={"operation":{"Details":{"User":"test (test) <tes@test.com>","keyExportType":"public"}}}
https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/getPGPKey?INPUT_DATA={"operation":{"Details":{"User":"test (test) <tes@test.com>","keyExportType":"private"}}}

サンプル応答

キーファイル

57。スタティックとダイナミックリソースグループを作成する

説明

PAM360でスタティックとダイナミックリソースグループ両方を作成する。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

POST

入力データ

以下のデータを入力としてパスし、スタティックリソースグループを作成する必要があります：

INPUT_DATA={
"operation": {
"Details": {
"GROUPNAME": "CG1",
"DESCRIPTION": "description",
"PARENTGROUPID": 306,
"GROUPTYPE":"STATIC",
"POLICY": "Low",
"NoHelpDeskRetrieval": "false"
}}}

以下のデータを入力としてパスし、ダイナミックリソースグループを作成する必要があります：

INPUT_DATA={
"operation": {
"Details": {
"GROUPNAME": "CG3",
"DESCRIPTION": "description",
"PARENTGROUPID": 3002,
"POLICY": "Low",
"NoHelpDeskRetrieval": "false",
"GROUPTYPE":"DYNAMIC",
"andor": "and",
"NoOfCriteria": 2,
"condition_1": "RESOURCENAME",
"operator_1": "CONTAINS",
"valuefield_1": "a",
"condition_2": "LOGINNAME",
"operator_2": "CONTAINS",
"valuefield_2": "e"
}}}

サンプル要求

curl -X POST -k -H "AUTHTOKEN:<<Authtoken_generated_from_PAM360>>" -H "Content-Type: text/json" https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup --data-urlencode "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\": \"PAM360\"} } }"

サンプル出力

{ "operation": { "name":"CREATE RESOURCE GROUP", "result": { "status":"Success", "message":"Group CG1 has been added successfully."} } }

58。監査詳細を取得する

説明

監査詳細をPAM360で取得する.

URL

https://<Host-Name-of-PAM360-ServerORIPaddress>:<Port>/restapi/json/v1/audit?AUDITTYPE=<<Resource/User>>&STARTINDEX=&LIMIT=&DURATION=<<TODAY / YESTERDAY/ LAST_7_DAYS >>

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

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": "PAM360 could not verify the password integrity.",
"NAME": "N/A",
"CLIENT": "Web Client"
} ] } }

59。リソースをユーザーと共有する

説明

リソースをユーザーと共有します。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/<resourceid>/share

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

PUT

入力データ

INPUT_DATA={"operation":{"Details":{"ACCESSTYPE": "modify","USERID":"1"}}}

Allowed accesstypes: view, modify, fullaccess, revoke

サンプル要求

https://<Host-Name-of-PAM360-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."}}}

60。アカウントをユーザーと共有する

説明

アカウントをユーザーと共有します。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/<resourceid>/accounts/<accountid>/share

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

PUT

入力データ

INPUT_DATA={"operation":{"Details":{"ACCESSTYPE":"modify","USERID":"1"}}}

Allowed accesstypes: view, modify, revoke

サンプル要求

https://<Host-Name-of-PAM360-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."}}}

61。リソースをユーザーグループと共有する

(このAPIはPAM360ビルド5100以上のみで機能します)

説明

リソースをユーザーグループと共有します

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/<resourceid>/share

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

orgName= <<org display name>>

HTTPメソッド

PUT

入力データ

INPUT_DATA={"operation":{"Details":{"ACCESSTYPE":"view","USERGROUPID":"1"}}}

Allowed accesstypes: view, modify, fullaccess, revoke

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/1/share

サンプル応答

{ "operation": { "result": { "message": "Read Only permission granted to user group(s) successfully.", "status": "Success" }, "name": "SHARE RESOURCE" } }

62。アカウントをユーザーグループと共有する

(このAPIはPAM360ビルド5100以上のみで機能します)

説明

アカウントをユーザーグループと共有します

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/<resourceid>/accounts/<accountid>/share

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

orgName= <<org display name>>

HTTPメソッド

PUT

入力データ

INPUT_DATA={"operation":{"Details":{"ACCESSTYPE":"view","USERGROUPID":"1"}}}

Allowed accesstypes: view, modify, fullaccess, revoke

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/1/accounts/1/share

サンプル応答

{ "operation": { "result": { "message": "Read Only permission granted to user group(s) successfully.", "status": "Success" }, "name": "SHARE ACCOUNT" } }

63。ユーザーグループIDを取り込む

(このAPIはPAM360ビルド5100以上のみで機能します)

説明

ユーザーグループのユーザーグループIDを取り込みます

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/user/getUserGroupId?USERGROUPNAME=<usergroupname>

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

orgName= <<org display name>>

HTTPメソッド

GET

サンプル要求

https://<Host-Name-of-PAM360-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"}}}

64。Linuxリソースにリモートパスワードリセットを構成する

(このAPIはPAM360ビルド5100以上のみで機能します)

説明

Linuxリソースにリモートパスワードリセットを構成します

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/configureremotepasswordreset

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

POST

入力データ

INPUT_DATA={"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":"test", "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-PAM360-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": "pam360-os1.win.domain.com", "RESOURCEID": "3"},{ "STATUS": "SUCCESS", "RESOURCENAME": "DC-u16.lin.domain.com", "RESOURCEID": "4"}]}, "name": "CONFIGURE REMOTE PASSWORD RESET"}}

65。SSL証明書を展開する
(このAPIはPAM360ビルド5300以上のみで機能します)

説明

SSL証明書を展開します。

HTTPSメソッド

POST

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

入力データ

INPUT_DATA={"operation":{"Details":{"common_name":"testcert","serial_number":"xxxxxxxx","serverName":"testmachine"}}}

注記：サーバー名の入力は任意です。サーバー名で、その特定のサーバーに証明書を展開できます。サーバー名がない場合、証明書は、クライアントのすべての保存されたサーバーに展開されます。

サンプル要求

https://<Host-Name-of-PAM360-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"
}]}

66。SSL証明書をユーザーと共有すうｒ
(このAPIはPAM360ビルド5300以上のみで機能します)

説明

SSL証明書をユーザーと共有します。

HTTPSメソッド

POST

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/shareCertificateToUser

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

入力データ

INPUT_DATA:{"operation":{"Details":{ "common_name":"certificate","serial_number":"179ae1f45a8" ,"userId":"301"}}}

サンプル応答

{ "result": {
"message": "Certificate shared successfully.",
"status": "Success"
}, "name": "ShareCertificate"}

67。SSL証明書をユーザーグループと共有するユーザーグループと共有する
(このAPIはPAM360ビルド5300以上のみで機能します)

説明

SSL証明書をユーザーグループと共有します。

HTTPSメソッド

POST

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/shareCertificateToUserGroup

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

入力データ

INPUT_DATA:{"operation":{"Details":{ "common_name":"certificate","serial_number":"179ae1f45a8" ,"userGroupId":"301"}}}

サンプル応答

{ "result": { "message": "Certificate shared successfully.", "status": "Success" }, "name": "ShareCertificate" }

68。SSL証明書をユーザーと共有する
(このAPIはPAM360ビルド5300以上のみで機能します)

説明

SSL証明書グループをユーザーと共有します。

HTTPSメソッド

POST

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/shareCertificateGroupToUser

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

入力データ

INPUT_DATA:{"operation":{"Details":{ "certificate_group_name":"certificate" ,"userId":"301"}}}

サンプル応答

{ "result": { "message": "Certificate shared successfully.", "status": "Success" }, "name": "ShareCertificate" }

69。SSL証明書グループをユーザーグループと共有する
(このAPIはPAM360ビルド5300以上のみで機能します)

説明

SSL証明書グループをユーザーグループと共有します。

HTTPSメソッド

POST

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/shareCertificateGroupToUserGroup

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

入力データ

INPUT_DATA:{"operation":{"Details":{ "certificate_group_name":"certificate" ,"userGroupId":"301"}}}

サンプル応答

{ "result": { "message": "Certificate shared successfully.", "status": "Success" }, "name": "ShareCertificate" }

70。SSL証明書をユーザーから取り消す
(このAPIはPAM360ビルド5300以上のみで機能します)

説明

ユーザーのSSL証明書を取り消します。

HTTPSメソッド

POST

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/revokeCertificateFromUser

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

入力データ

INPUT_DATA:{"operation":{"Details":{ "common_name":"certificate","serial_number":"179ae1f45a8" ,"userId":"301"}}}

サンプル応答

{ "result": { "message": "Access to certificate revoked successfully.", "status": "Success" }, "name": "RevokeCertificate" }

71。SSL証明書をユーザーグループから取り消す
(このAPIはPAM360ビルド5300以上のみで機能します)

説明

ユーザーグループのSSL証明書を取り消します。

HTTPSメソッド

POST

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/revokeCertificateFromUserGroup

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

入力データ

INPUT_DATA:{"operation":{"Details":{ "common_name":"certificate","serial_number":"179ae1f45a8" ,"userGroupId":"301"}}}

サンプル応答

{ "result": { "message": "Access to certificate revoked successfully.", "status": "Success" }, "name": "RevokeCertificate" }

72。SSL証明書グループをユーザーから取り消す
(このAPIはPAM360ビルド5300以上のみで機能します)

説明

ユーザーのSSL証明書グループを取り消します。

HTTPSメソッド

POST

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/revokeCertificateGroupFromUser

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

入力データ

INPUT_DATA:{"operation":{"Details":{ "certificate_group_name":"certificate" ,"userId":"301"}}}

サンプル応答

{ "result": { "message": "Access to certificate revoked successfully.", "status": "Success" }, "name": "RevokeCertificate" }

73。SSL証明書グループをユーザーグループから取り消す
(このAPIはPAM360ビルド5300以上のみで機能します)

説明

ユーザーグループのSSL証明書グループを取り消します。

HTTPSメソッド

POST

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/revokeCertificateGroupFromUserGroup

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

入力データ

INPUT_DATA:{"operation":{"Details":{ "certificate_group_name":"certificate" ,"userGroupId":"301"}}}

サンプル応答

{ "result": { "message": "Access to certificate revoked successfully.", "status": "Success" }, "name": "RevokeCertificate" }

74。SSL証明書グループを作成する
(このAPIはPAM360ビルド5300以上のみで機能します)

説明

SSL証明書グループを作成します。

HTTPSメソッド

POST

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/createCertificateGroup

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

入力データ

INPUT_DATA={"operation":{"Details":{ "group_name":"NAME","group_description":"This is the description for the group certificate","group_mail":"pam360@zohocorporation.com","ssl_details":"301,202"}}}

サンプル応答

{"result":{"message":"Certificate group added successfully.","status":"Success"},"name":"createCertificateGroup"}

75。SSL証明書グループを削除する
(このAPIはPAM360ビルド5300以上のみで機能します)

説明

SSL証明書グループを削除します。

HTTPSメソッド

削除

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/deleteCertificateGroup

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

入力データ

INPUT_DATA={"operation":{"Details":{ "group_name":"NAME"}}}

サンプル応答

{"result":{"message":"The certificate group is deleted successfully.","status":"Success"},"name":"deleteCertificateGroup"}

76。SSL証明書グループを編集する
(このAPIはPAM360ビルド5300以上のみで機能します)

説明

SSL証明書グループを編集します。

HTTPSメソッド

POST

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/editCertificateGroup

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

入力データ

INPUT_DATA={"operation":{"Details":{ "group_name":"NEW NAME","group_description":"This is new description for the group certificate","group_mail":"pam360@zohocorporation.com","ssl_details":"1,2,3"}}}

サンプル応答

{"result":{"message":"The certificate group is updated successfully.","status":"Success"},"name":"editCertificateGroup"}

77。SSLエージェントインストールキーを生成する
(このAPIはPAM360ビルド5300以上のみで機能します)

説明

SSLエージェンインストールキーを生成する。

HTTPSメソッド

POST

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/api/pki/restapi/generateInstallKey

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

サンプル応答

{ "result": { "message": "Agent install key fetched successfully", "status": "Success" }, "name": "GetAgentInstallKey", "totalRows": 1, "AgentInstallKey": "20570b9e0ceaa936" }

78。パスワードポリシーを取得する
(このAPIはPAM360ビルド5300以上のみで機能します)

説明

組織のすべてのパスワードポリシーを一覧表示します。

HTTPSメソッド

GET

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/passwords/policies

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

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" } }

79。すべてのリソースタイプを取得する
(このAPIはPAM360ビルド5300以上のみで機能します)

説明

すべてのリソースの種類を一覧表示します。

HTTPSメソッド

GET

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/resourcetypes

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

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", "ISDEFAULT_SUPPORTED_RESOURCETYPE": "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", "ISDEFAULT_SUPPORTED_RESOURCETYPE": "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", "ISDEFAULT_SUPPORTED_RESOURCETYPE": "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" } }

80。リソースをリソースグループに関連づける
(このAPIはPAM360ビルド5400以上のみで機能します)

説明

リソースをリソースグループに関連づけます。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup/<groupId>/associateResources

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

orgName= <<org display name>>

HTTPメソッド

POST

入力データ

INPUT_DATA={ "operation": {"Details": { RESOURCEIDS:[1, 2] }}}

サンプル要求

https://<Host-Name-of-PAM360-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" }}

81。リソースをリソースグループから関連づけ解除する
(このAPIはPAM360ビルド5400以上のみで機能します)

説明

リソースのリソースグループとの関連づけを解除します。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup/<groupId>/disassociateResources

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

orgName= <<org display name>>

HTTPメソッド

POST

入力データ

INPUT_DATA={ "operation": {"Details": { RESOURCEIDS:[1, 2] }}}

サンプル要求

https://<Host-Name-of-PAM360-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" }}

82。リソースに関連づけられたリソースグループを取り込む
(このAPIはPAM360ビルド5400以上のみで機能します)

説明

リソースに関連づけられたリソースグループを取り込みます。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/<ResourceId>/associatedGroups

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

orgName= <<org display name>>

HTTPメソッド

GET

サンプル要求

https://<Host-Name-of-PAM360-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" }}

83。リソースグループを削除する
(このAPIはPAM360ビルド5400以上のみで機能します)

説明

特定のリソースグループを削除します。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup?RESOURCEGROUPID=<resourcegroupid>

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

orgName= <<org display name>>

HTTPメソッド

削除

サンプル要求

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup?RESOURCEGROUPID=<resourcegroupid>

サンプル応答

{ "operation":{ "name":"DELETE RESOURCE GROUP","result": { "status":"Success","message":"Resource Group deleted successfully." }}}

84。リソースグループIDを取り込む
(このAPIはPAM360ビルド5400以上のみで機能します)

説明

リソースグループのIDを取り込みます。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup/getResourceGroupId?RESOURCEGROUPNAME=<resourcegroupname>&USERID=<userid>

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

GET

パラメータ

RESOURCEGROUPNAME=<resourcegroupname> USERID=<userid>

サンプル要求

https://<Host-Name-of-PAM360-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" }}}

85。二要素認証をリセットする
(このAPIはPAM360ビルド5400以上のみで機能します)

説明

ユーザー名の二要素認証をリセットする。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/user/resetMFA?USERNAME=<username>

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

PUT

パラメーター

USERNAME=<username>

サンプル要求

https://<Host-Name-of-PAM360-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"
}
}

86。すべてのリソースグループを取り込む
(このAPIはPAM360ビルド6000以上のみで機能します)

説明

ユーザーのすべての所有および共有されたリソースグループを取り込みます。

URL

https://<Host-Name-of-PAM360-Server OR IPddress>:<Port>/restapi/json/v1/resourcegroup

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>
orgName= <<org display name>>

HTTPメソッド

GET

入力データ

なし

サンプル出力

{
"operation": {
"result": {
"message": "Resource group list fetched successfully",
"status": "Success",
"statusCode": 20000
},
"Details": [
{
"resourceGroupDescription": "Group of Windows resources",
"accessType": "modify",
"resourceGroupName": "a2",
"isOwner": "false",
"resourceGroupType": "dynamic",
"resourceGroupId": "1201",
"timeCreated": "2023-02-24 18:01:24.378",
"subGroupOf": "1", //Parent ID
"ownerId": "1"
},
{
"resourceGroupDescription": "All the resources created by me",
"accessType": "fullaccess",
"resourceGroupName": "Default Group",
"isOwner": "true",
"resourceGroupType": "static",
"resourceGroupId": "301",
"timeCreated": "2023-02-14 14:55:22.998",
"subGroupOf": "",
"ownerId": "301"
},
{
"resourceGroupDescription": "Group of Linux resources",
"accessType": "fullaccess",
"resourceGroupName": "st1",
"isOwner": "false",
"resourceGroupType": "static",
"resourceGroupId": "1202",
"timeCreated": "2023-02-24 18:02:10.251",
"subGroupOf": "2",
"ownerId": "1"
},
{
"resourceGroupDescription": "Group of Windows Domain resources",
"accessType": "fullaccess",
"resourceGroupName": "static",
"isOwner": "false",
"resourceGroupType": "static",
"resourceGroupId": "901",
"timeCreated": "2023-02-24 16:08:26.262",
"subGroupOf": "3",
"ownerId": "1"
}
],
"name": "GET_RESOURCE_GROUPS",
"totalRows": 4
}
}

87。パスワード認証者
(このAPIはPAM360ビルド6000以上のみで機能します)

説明

パスワードポリシーに基づいて与えられたパスワードを認証します。

URL

https://<Host-Name-of-PAM360-Server OR IPddress>:<Port>/restapi/json/v1/passwords/validate

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>
orgName= <<org display name>>

HTTPメソッド

POST

サンプル入力

INPUT_DATA={
"operation":{
"details":{
"password": "Test@123",
// Either passwordPolicy or passwordPolicyId should be given
"passwordPolicy": "Strong",
"passwordPolicyId":"1"
}
}
}

サンプル出力

{
"operation": {
"result": {
"message": "Valid",
"status": "Success",
"statusCode": 20000
},
"name": "VALIDATE_PASSWORD"
}
}

88。ユーザーグループを削除する
(このAPIはPAM360ビルド6000以上のみで機能します)

説明

ユーザーグループを個別組織から削除する。

URL

https://<Host-Name-of-PAM360-Server OR IPddress>:<Port>/restapi/json/v1/userGroup

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>
orgName= <<org display name>>

HTTPメソッド

削除

サンプル入力

INPUT_DATA={
"operation": {
"details": {
"userGroupIds": [1231,24553]
}
}
}

サンプル出力

{
"operation": {
"result": {
"message": "User group(s) has been deleted successfully.",
"status": "Success",
"statusCode": 20000
},
"Details": {
"1231": {
"message": "Invalid User group Id.",
"status": "Failed",
"statusCode": 46000
},
"24553": {
"message": "User group(s) has been deleted successfully.",
"status": "Success",
"statusCode": 20000
}
},
"name": "DELETE_USERGROUP"
}
}

89。PAM360エージェントキーを生成および取り込む
(このAPIはPAM360ビルド6000以上のみで機能します)

説明

利用可能なPAM360エージェントキーを取り込むか、新しいキーを生成および取り込む。

URL

https://<Host-Name-of-PAM360-Server OR IPddress>:<Port>/restapi/json/v1/agents/agentkey

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>
orgName= <<org display name>>

HTTPメソッド

POST

入力データ

Provide INPUT_DATA only for generating a new agent key.

サンプル入力

INPUT_DATA={
"operation": {
"details": {
"generateAgentKey": "true",
"validityPeriod":3 // Provide this param to use the agent key in multiple installations for a stipulated time (In hours).
}
}
}

サンプル出力

{
"operation": {
"result": {
"message": "Fetched Agent Key successfully.",
"status": "Success",
"statusCode": 20000
},
"Details": {
"agentKey": "66f835703f814e2e",
"agentKeyEndTime": "09/02/2023 01:03:31"
},
"operationName": "Fetch Agent Key"
}
}

90。HAステータスを取り込む
(このAPIはPAM360ビルド6000以上のみで機能します)

説明

高可用性サーバーのステータスを取得します。

URL

https://<Host-Name-of-PAM360-Server OR IPddress>:<Port>/restapi/json/v1/server/getHighAvailabilityStatus

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>
orgName= <<org display name>>

HTTPメソッド

GET

入力データ

なし

サンプル出力

{
"operation": {
"name": "Get HA Status",
"result": {
"status": "Success",
"message": "HA Status fetched successfully"
"statusCode":20000
},
"Details":{
"haStatus":"active",
"isPrimaryServer":"true",
"primaryServer":"master.server.com",
"primaryServerStatus":"active",
"secondaryServer":"slave.server.com",
"secondaryServerStatus":"active",
}
}
}

91。ユーザーをユーザー宮r－プから削除する
(このAPIはPAM360ビルド6000以上のみで機能します)

説明

個別組織のユーザーグループからユーザーを削除します。

URL

https://<Host-Name-of-PAM360-Server OR IPddress>:<Port>/restapi/json/v1/user/removeUserFromUserGroup

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>
orgName= <<org display name>>

HTTPメソッド

POST

サンプル入力

INPUT_DATA={
"operation":{
"Details":{
"USERIDS":[1,2],
"USERGROUPIDS":[2,3]
}
}
}

サンプル出力

{
"operation": {
"result": {
"message": "Users removed from User Group Successfully",
"status": "Success"
},
"Details": {
"RESULT": [
{
"USERID": "1",
"message": "User Removed Successfully",
"USERGROUPID": "2",
"status": "Success"
},
{
"USERID": "1",
"message": "User does not exist in the User Group",
"USERGROUPID": "3",
"status": "Failed"
},
{
"USERID": "2",
"message": "User does not exist in the User Group",
"USERGROUPID": "2",
"status": "Failed"
},
{
"USERID": "2",
"message": "User Removed Successfully",
"USERGROUPID": "3",
"status": "Success"
}
]
},
"name": "REMOVE USER FROM USER_GROUP"
}
}

92。すべてのユーザーを取り込む
(このAPIはPAM360ビルド6320以上のみで機能します)

説明

すべてのユーザー詳細を取り込む。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/user

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>
orgName= <<org display name>>

HTTPメソッド

GET

メモ：デフォルト制限100,は、「制限」が指定されていない場合に適用されます。

入力データ

INPUT_DATA=
{
"operation": {
"Details": {
"limit": 3,
"startIndex": 1,
"searchValue": "admin@zohocorp.com",
"searchColumn": "userId|userName|email|role|department|location|orgName|isApiUser|isTfaEnabled|isSuperAdmin|isUserLocked",
"searchOperator": "contains|doesNotContain|equals|notEquals|startsWith|endsWith"
}
}
}

サンプル出力

{
"operation": {
"result": {
"message": "User(s)' details have been fetched successfully.",
"status": "Success",
"statusCode": 20000
},
"Details": [
{
"role": "Privileged Administrator",
"isApiUser": false,
"isSuperAdmin": false,
"userName": "admin",
"isTfaEnabled": false,
"userId": 1,
"isAddonAccessEnabled": true,
"isUserLocked": false,
"dateCreated": "2023-06-15 11:27:21.11",
"trustScore": "66",
"location": "",
"department": "",
"isMobileAccessEnabled": true,
"email": "aaaadmin@zohocorp.com"
},
{
"role": "Password User",
"isApiUser": false,
"isSuperAdmin": false,
"userName": "guest",
"isTfaEnabled": false,
"userId": 2,
"isAddonAccessEnabled": true,
"isUserLocked": false,
"dateCreated": "2023-06-15 11:27:21.11",
"trustScore": "N/A",
"location": "",
"department": "",
"isMobileAccessEnabled": true,
"email": "guest@zohocorp.com"
},
{
"role": "Administrator",
"isApiUser": true,
"isSuperAdmin": false,
"userName": "apiAdmin",
"isTfaEnabled": false,
"userId": 301,
"isAddonAccessEnabled": false,
"isUserLocked": false,
"dateCreated": "2023-06-15 11:37:50.345",
"trustScore": "N/A",
"location": "",
"department": "",
"isMobileAccessEnabled": false,
"email": ""
}
],
"name": "GET_USER(S)",
"totalRows": 3
}
}

93。すべてのユーザーグループを取り込む
(このAPIはPAM360ビルド6320以上のみで機能します)

説明

すべてのユーザーグループを取り込む。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/userGroup

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>
orgName= <<org display name>>

HTTPメソッド

GET

メモ：デフォルト制限100,は、「制限」が指定されていない場合に適用されます。

入力データ

INPUT_DATA=
{
"operation": {
"Details": {
"limit": 3,
"startIndex": 1,
"searchValue": "sample",
"searchColumn": "userGroupId|userGroupName|description",
"searchOperator": "contains|doesNotContain|equals|notEquals|startsWith|endsWith"
}
}
}

サンプル出力

{
"operation": {
"result": {
"message": "User group(s)' details have been fetched successfully.",
"status": "Success",
"statusCode": 20000
},
"Details": [
{
"userGroupName": "Sample",
"userGroupId": 301,
"dateCreated": "2023-06-01 12:48:35.862",
"description": "For sample purpose"
}
],
"operationName": "GET_USERGROUP(S)",
"totalRows": 1
}
}

94。リソースグループをユーザーに一括共有する
(このAPIはPAM360ビルド6320以上のみで機能します)

説明

リソースグループをユーザーに一括共有する。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup/share

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>
orgName= <<org display name>>

HTTPメソッド

PUT

入力データ

INPUT_DATA=
{
"operation": {
"Details": {
"resourceGroupIds": ["301","302","601"],
"userIds":["1","2"],
"accessType":"view|modify|fullaccess|revoke"
}
}
}

サンプル出力

{
"operation": {
"result": {
"message": "Revoke action triggered. Refer Audit for more details.",
"status": "Success",
"statusCode": 20001
},
"operationName": "SHARE_RESOURCEGROUP(S)"
}
}

95。リソースグループをユーザーグループに一括共有する
(このAPIはPAM360ビルド6320以上のみで機能します)

説明

リソースグループをユーザーグループに一括共有する。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resourcegroup/share

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>
orgName= <<org display name>>

HTTPメソッド

PUT

入力データ

INPUT_DATA=
{
"operation": {
"Details": {
"resourceGroupIds": ["301","302","601"],
"userGroupIds": ["1","2"],
"accessType":"view|modify|fullaccess|revoke"
}
}
}

サンプル出力

{
"operation": {
"result": {
"message": "Revoke action triggered. Refer Audit for more details.",
"status": "Success",
"statusCode": 20001
},
"operationName": "SHARE_RESOURCEGROUP(S)"
}
}

96。リソースをユーザーに一括共有する
(このAPIはPAM360ビルド6320以上のみで機能します)

説明

リソースをユーザーに一括共有する。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/share

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>
orgName= <<org display name>>

HTTPメソッド

PUT

入力データ

INPUT_DATA=
{
"operation": {
"Details": {
"resourceIds": ["301","302","601"],
"userIds":["1","2"],
"accessType":"view|modify|fullaccess|revoke"
}
}
}

サンプル出力

{
"operation": {
"result": {
"message": "Revoke action triggered. Refer Audit for more details.",
"status": "Success",
"statusCode": 20001
},
"operationName": "SHARE_RESOURCE(S)"
}
}

97。リソースをユーザーグループに一括共有する
(このAPIはPAM360ビルド6320以上のみで機能します)

説明

リソースをユーザーグループに一括共有する。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/share

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>
orgName= <<org display name>>

HTTPメソッド

PUT

入力データ

INPUT_DATA=
{
"operation": {
"Details": {
"resourceIds": ["301","302","601"],
"userGroupIds":["1","2"],
"accessType":"view|modify|fullaccess|revoke"
}
}
}

サンプル出力

{
"operation": {
"result": {
"message": "Revoke action triggered. Refer Audit for more details.",
"status": "Success",
"statusCode": 20001
},
"operationName": "SHARE_RESOURCE(S)"
}
}

98。アカウントをユーザーに一括共有する
(このAPIはPAM360ビルド6320以上のみで機能します)

説明

アカウントをユーザーに一括共有する。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/accounts/share

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>
orgName= <<org display name>>

HTTPメソッド

PUT

入力データ

INPUT_DATA=
{
"operation": {
"Details": {
"accountIds": ["301","302","601"],
"userIds":["1","2"],
"accessType":"view|modify|remoteapponly|revoke",
"remoteAppIds":["1","2"], //in case of remoteapponly accessType
"resourceId":1 //in case of remoteapponly accessType
}
}
}

サンプル出力

{
"operation": {
"result": {
"message": "Revoke action triggered. Refer Audit for more details.",
"status": "Success",
"statusCode": 20001
},
"operationName": "SHARE_ACCOUNTS(S)"
}
}

99。アカウントをユーザーグループに一括共有する
(このAPIはPAM360ビルド6320以上のみで機能します)

説明

アカウントをユーザーグループに一括共有する。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/accounts/share

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>
orgName= <<org display name>>

HTTPメソッド

PUT

入力データ

INPUT_DATA=
{
"operation": {
"Details": {
"accountIds": ["301","302","601"],
"userGroupIds": ["1","2"],
"accessType":"view|modify|remoteapponly|revoke",
"remoteAppIds":["1","2"], //in case of remoteapponly accessType
"resourceId":1 //in case of remoteapponly accessType
}
}
}

サンプル出力

{
"operation": {
"result": {
"message": "Revoke action triggered. Refer Audit for more details.",
"status": "Success",
"statusCode": 20001
},
"operationName": "SHARE_ACCOUNTS(S)"
}
}

100。すべての関連づけられたリモートアプリIDを取り込む
(このAPIはPAM360ビルド6320以上のみで機能します)

説明

PAM360のリソースと関連づけられたリモートアプリIDを取り込む。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/resources/<resource-id>/associated-remote-apps

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>
orgName= <<org display name>>

HTTPメソッド

GET

入力データ

なし

サンプル出力

{
"operation": {
"result": {
"message": "Remote apps associated with the provided resource have been fetched successfully.",
"status": "Success",
"statusCode": 20000
},
"Details": [
{
"name": "sample1",
"id": "1"
},
{
"name": "sample2",
"id": "2"
}
],
"name": "GET_REMOTEAPPS_ASSOCIATED_WITH_RESOURCE",
"totalRows": 2
}
}

101。組織詳細を取得する
(このAPIはPAM360ビルド6320以上のみで機能します)

説明

ユーザーのすべてのアクセス可能な組織詳細を取得する。

URL

https://<Host-Name-of-PAM360-Server OR IP address>:<Port>/restapi/json/v1/organizations

ヘッダ

AUTHTOKEN=<<Authtoken_generated_from_PAM360>>

HTTPメソッド

GET

入力データ

なし

サンプル出力

{
"operation": {
"result": {
"message": "Fetched organization(s) successfully.",
"status": "Success",
"statusCode": 20000
},
"Details": [
{
"name": "sample1",
"id": "1",
"displayName":"sample1"
},
{
"name": "sample2",
"id": "2",
"displayName":"sample1"
}
],
"name": "GET_ORGANIZATIONS",
"totalRows": 2
}
}