Credentil API（認証情報マネージャー）

Credentil APIで必要パラメーターを送信すると、認証情報の追加、更新、削除、リストアップが可能です。このAPIでは、GETリクエストとPOSTリクエストをサポートしています。

メモ：パラメーターに特殊文字を利用する場合は、HTMLエンコードが必要です。たとえば、パスワードに#、&、%、+などが利用されている場合、次のように処理してから、パスワードをAPIに引き渡してください。

#は%23に置き換えます。

&は%26に置き換えます。

%は%25に置き換えます。

+は%2Bに置き換えます。

その他の記号のエンコード法などは、MDN Web Docs（Mozilla開発者情報）や、w3schools.com（簡易テスト ツールあり）を参照ください。

Credentil APIでの認証情報の追加・編集・削除などには、POSTメソッドの利用を推奨します。

認証情報マネージャーの追加

管理者はこのAPIで、Applications Managerのメール アクションを追加できます。APIリクエストで共通のパラメーターは、次の通りです。

フィールド 説明
credentialName 一意の認証情報名を入力してください
type 認証情報タイプを指定してください。構文で指定されているのと同じタイプを使う必要があります。
credentialDescr 認証情報の説明です。
credentialID Applications Managerが認証情報にセットする一意の識別子です。

 

フィールド 説明
サーバー
Telnet

必要パラメーター

  • type
  • username
  • prompt
  • password

構文：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[API_KEY]&type=Telnet&credentialDescr=[CREDENTIAL_DESCRIPTION]&credentialName=[CREDENTIANL_NAME]&username=[USER_NAME]&prompt=$&password=[PASS_WORD]

リクエスト サンプル
http://apm-server:9090/AppManager/xml/credential?apikey=05b4a12a5fc0747cfaa897850ae9a778&type=Telnet&credentialDescr=Test&credentialName=Telnet&username=test&prompt=$&password=test
SNMPv1/v2

必要パラメーター

  • type
  • snmpCommunityString
  • timeout

構文：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[API_KEY]&type=SNMP v1v2&credentialDescr=[CREDENTIAL_DESCRIPTION]&credentialName=[CREDENTIANL_NAME]&snmpCommunityString=[COMMUNITY_STRING]&timeout=[MINUTES]

リクエスト サンプル
http://apm-server:9090/AppManager/xml/credential?apikey=05b4a12a5fc0747cfaa897850ae9a778&type=SNMP v1v2&credentialDescr=Test&credentialName=Credential-SNMPv2&snmpCommunityString=public&timeout=5
SNMPv3

必要パラメーター

  • type
  • snmpAuthProtocol
  • snmpContextName
  • snmpPrivPassword
  • snmpAuthPassword
  • snmpSecurityLevel
  • timeout
  • snmpUserName

構文：
https://apm-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&type=SNMP v3&snmpAuthProtocol=[MD5_OR_SHA]&credentialName=[CREDENTIAL_NAME]&snmpContextName=[CONTEXT_NAME]&snmpPrivPassword=[PRIVATE_PASSWORD]&snmpSecurityLevel=[NOAUTHNOPRIV_OR_AUTHNOPRIV_OR_AUTHPRIV]&snmpAuthPassword=[AUTHENTICATION_PASSWORD]&timeout=[MINUTES]&snmpusername=[USER_NAME]

リクエスト サンプル
https://apm-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&snmpAuthProtocol=MD5&credentialName=snmp-v3-1&snmpContextName=cusu4NfK6N0s6b&snmpPrivPassword=&snmpSecurityLevel=NOAUTHNOPRIV&snmpAuthPassword=&type=SNMP v3&timeout=5&snmpusername=admin
SSH

必要パラメーター

  • type
  • username
  • passphrase
  • 説明
  • prompt
  • password
  • sshPKAuth

構文：
https://apm-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&type=SSH&credentialName=[CREDENTIAL_NAME]&username=[USER_NAME]&passphrase=[PASS_PHRASE]&description=[PRIVATE_KEY]&prompt=[PROMPT]&password=[PASS_WORD]&sshPKAuth=on

リクエスト サンプル
https://apm-server:9090/AppManager/xml/credential/add?apikey=4dd329f4b42f64c29013c591138eac2a&credentialName=ssh-1&username=guest&passphrase=&description=&prompt=$&type=SSH&password=guest
WMI

必要パラメーター

  • type
  • username
  • password

構文：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[API_KEY]&type=WMI&credentialDescr=[CREDENTIAL_DESCRIPTION]&credentialName=[CREDENTIANL_NAME]&username=[USER_NAME]&password=[PASS_WORD]

リクエスト サンプル
http://apm-server:9090/AppManager/xml/credential?apikey=05b4a12a5fc0747cfaa897850ae9a778&type=WMI&credentialDescr=Test&credentialName=WMI&username=administrator&password=admin123
アプリケーション サーバー
GlassFish

必要パラメーター

  • type
  • password
  • JNDIPath
  • username

構文：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[API_KEY]&type=GlassFish&credentialDescr=[CREDENTIAL_DESCRIPTION]&credentialName=[CREDENTIANL_NAME]&username=[USER_NAME]&password=[PASS_WORD]&JNDIPath=[PATH]

リクエスト サンプル
http://apm-server:9090/AppManager/xml/credential?apikey=05b4a12a5fc0747cfaa897850ae9a778&type=GlassFish&credentialDescr=Test&credentialName=Glassfish1&username=admin&password=adminadmin&JNDIPath=/jmxrmi
JBossサーバー

必要パラメーター

  • type
  • username
  • password
  • sslenabled

構文：
https://apm-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&type=JBoss server&credentialName=[CREDENTIAL_NAME]&username=[USER_NAME]&password=[PASS_WORD]&sslenabled=on

リクエスト サンプル
https://apm-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&credentialName=jboss-2&username=admin&type=JBoss server&password=password123&sslenabled=on
Microsoft .NET

必要パラメーター

  • type
  • username
  • password

構文：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[API_KEY]&type=Microsoft .NET&credentialName=[CREDENTIANL_NAME]&username=[USER_NAME]&password=[PASS_WORD]&credentialDescr=[CREDENTIAL_DESCRIPTION]

リクエスト サンプル
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=Microsoft .NET&credentialName=.Net1&username=administrator&password=password123&credentialDescr=This is .net credential.
VMware vFabric tc Server

必要パラメーター

  • type
  • password
  • JNDIPath
  • username

構文：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[API_KEY]&type=VMware vFabric tc Server&credentialDescr=[CREDENTIAL_DESCRIPTION]&credentialName=[CREDENTIANL_NAME]&password=[PASS_WORD]&JNDIPath=[JNDI_PATH]&username=[USER_NAME]

リクエスト サンプル
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=VMware vFabric tc Server&credentialName=vFabric1&Password=springsource&JNDIPath=/jmxrmi&username=admin
WebLogic Server

必要パラメーター

  • type
  • username
  • password
  • version

構文
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[API_KEY]&type=WebLogic Server&credentialDescr=[CREDENTIAL_DESCRIPTION]&credentialName=[CREDENTIANL_NAME]&username=[USER_NAME]&password=[PASS_WORD]&version=[WLS_6_1 or WLS_7_0 or WLS_8_1 or WLS_9_0 or WLS_10_0]

 

リクエスト サンプル
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=WebLogic Server&credentialName=Weblogic6.1&username=weblogic&password=weblogic&version=WLS_6_1
WebSphere Server

必要パラメーター

  • type
  • soapport
  • username
  • authEnabled
  • password
  • sslenabled
  • version

構文：
https://apm-server:9090/AppManager/xml/credential?apikey=[API_KEY]&type=WebSphere Server&soapport=[SOAP PORT]&credentialName=[CREDENTIAL_NAME]&username=[USER_NAME]&authEnabled=on&password=[PASS_WORD]&version=[5_OR_6_OR_7_OR_8]&sslenabled=on

 

リクエスト サンプル
https://apm-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&type=WebSphere Server&soapport=8880&credentialName=websphere7.x&username=wasadmin&authEnabled=on&password=admin&version=8&sslenabled=on
Apacheサーバー

必要パラメーター

  • type
  • username
  • authEnabled
  • password
  • sslenabled

構文：
https://apm-server:9090/AppManager/xml/credential?apikey=[API_KEY]&type=Apache Server&credentialName=[CREDENTIAL_NAME]&username=[USER_NAME]&authEnabled=on&password=[PASS_WORD]&sslenabled=on

リクエスト サンプル
https://apm-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&type=Apache Server&credentialName=Apache-1&username=test&authEnabled=on&password=test&sslenabled=on
Tomcatサーバー

必要パラメーター

  • type
  • username
  • password
  • sslenabled
  • version
  • tomcatmanagerurl

構文：
https://apm-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&tomcatmanagerurl=[TOMCAT_MANAGER_URL]&credentialName=[CREDENTIAL_NAME]&username=[USER_NAME]&type=Tomcat Server&password=e6Lg48eOS0331s&sslenabled=on&version=[3_OR_4_OR_5_OR_6_OR_7]

リクエスト サンプル
https://apm-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&tomcatmanagerurl=/manager&credentialName=Tomcat6&username=tomcat&type=Tomcat Server&password=tomcat&sslenabled=on&version=7
Java/トランザクション
Java Runtime

必要パラメーター

  • type
  • jndiurl
  • authEnabled
  • username
  • password

構文：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[API_KEY]&type=Java Runtime&credentialDescr=[CREDENTIAL_DESCRIPTION]&credentialName=[CREDENTIANL_NAME]&jndiurl=[JNDI_URL]&authEnabled=on&username=[USER_NAME]&password=[PASS_WORD]

リクエスト サンプル
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=Java Runtime&credentialName=JavaRuntime1&jndiurl=/jmxrmi&authEnabled=on&username=admin&password=admin
データベース
Db2

必要パラメーター

  • type
  • username
  • password
  • instance

構文：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[API_KEY]&type=DB2&credentialDescr=[CREDENTIAL_DESCRIPTION]&credentialName=[CREDENTIANL_NAME]&username=[USER_NAME]&password=[PASS_WORD]&instance=[DB NAME]

リクエスト サンプル
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=DB2&credentialName=DB2 server1&username=db2admin&password=db2admin&instance=SAMPLE
MS SQL

必要パラメーター

  • type
  • namedInstance
  • username
  • authType
  • instance
  • password

構文：
https://apm-server:9090/AppManager/xml/credential?apikey=[API_KEY]=MS SQL&credentialName=[CREDENTIAL_NAME]&username=[USER_NAME]&namedInstance=on&authType=[SQL or Windows]&instance=[INSTANCE]&password=[PASS_WORD]

リクエスト サンプル
https://apm-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&type=mssql&credentialName=SQL Server1&username=sa&namedInstance=on&authType=SQL&instance=instance&password=password123
MySQL

必要パラメーター

  • type
  • username
  • password
  • instance

構文：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[API_KEY]&type=MySQL&credentialDescr=[CREDENTIAL_DESCRIPTION]&credentialName=[CREDENTIANL_NAME]&username=[USER_NAME]&password=[PASS_WORD]&instance=[DB NAME]

リクエスト サンプル
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=MySQL&credentialName=MySQL4&username=root&password=root&instance=test
Oracle

必要パラメーター

  • type
  • password
  • username

構文：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[API_KEY]&type=Oracle&credentialDescr=[CREDENTIAL_DESCRIPTION]&credentialName=[CREDENTIANL_NAME]&username=[USER_NAME]&password=[PASS_WORD]

リクエスト サンプル
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=Oracle&credentialName=Oracle11.0.4&username=system&password=password123
PostgreSQL

必要パラメーター

  • type
  • username
  • password
  • DBname

構文：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[API_KEY]&type=PostgreSQL&credentialDescr=[CREDENTIAL_DESCRIPTION]&credentialName=[CREDENTIANL_NAME]&username=[USER_NAME]&password=[PASS_WORD]&DBname=[DB NAME]

リクエスト サンプル
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=PostgreSQL&credentialName=PostgreSQL3&UserName=postgres&Password=postgres&DBname=postgres
Sybase

必要パラメーター

  • type
  • username
  • instance
  • password

構文：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[API_KEY]&type=Sybase&credentialDescr=[CREDENTIAL_DESCRIPTION]&credentialName=[CREDENTIANL_NAME]&username=[USER_NAME]&instance=[INSTANCE NAME]&password=[PASS_WORD]

リクエスト サンプル
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=Sybase&credentialName=Sybase Server 4&username=sa&instance=test&password=test123
MongoDB

必要パラメーター

  • type
  • authreq
  • username
  • password

構文：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[API_KEY]&type=MongoDB&credentialDescr=[CREDENTIAL_DESCRIPTION]&credentialName=[CREDENTIANL_NAME]&authreq=on&username=USERNAME&password=[PASS_WORD]

リクエスト サンプル
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&credentialName=MongoDB7&authreq=on&type=MongoDB&username=root&password=root
Cassandra

必要パラメーター

  • type
  • username
  • authreq
  • password type=Cassandra

構文：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[API_KEY]&type=Cassandra&credentialDescr=[CREDENTIAL_DESCRIPTION]&credentialName=[CREDENTIANL_NAME]&username=USERNAME&authreq=on&password=[PASS_WORD]

リクエスト サンプル
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=Cassandra&credentialName=Cassandra1&username=cassandra&authreq=on&password=cassandra
ミドルウェア/ポータル
Microsoft MQ（MSMQ）

必要パラメーター

  • type
  • password
  • username

構文：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[API_KEY]&type=Microsoft MQ (MSMQ)&credentialDescr=[CREDENTIAL_DESCRIPTION]&credentialName=[CREDENTIANL_NAME]&Password=d6pM4M2&username=[USER_NAME]SERNAME

リクエスト サンプル
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=Microsoft MQ (MSMQ)&credentialName=MSMQ4&Password=Admin123&username=administrator
MS Office SharePoint

必要パラメーター

  • type
  • password
  • username

構文：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[API_KEY]&type=MS Office SharePoint&credentialDescr=[CREDENTIAL_DESCRIPTION]&credentialName=[CREDENTIANL_NAME]&password=[PASS_WORD]&username=[USER_NAME]

リクエスト サンプル
http://apm-server:9090/AppManager/xml/credential?apikey=05b4a12a5fc0747cfaa897850ae9a778&type=MS Office SharePoint&credentialDescr=Test&credentialName=MS Sharepoint3&Password=Password123&username=administrator
RabbitMQ

必要パラメーター

  • type
  • password
  • username

構文：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[API_KEY]&type=RabbitMQ&credentialDescr=[CREDENTIAL_DESCRIPTION]&credentialName=[CREDENTIANL_NAME]&password=[PASS_WORD]&username=[USER_NAME]

リクエスト サンプル
http://apm-server:9090/AppManager/xml/credential?apikey=05b4a12a5fc0747cfaa897850ae9a778&type=RabbitMQ&credentialDescr=Test&credentialName=RabbitMQ5&Password=guest&UserName=guest

認証情報の編集/更新

管理者はこのAPIで既存の認証情報を編集できます。

構文

XMLでレスポンスを受けるには

http://[APM Host]:[APM Port]/AppManager/xml/credential?apikey=[API_KEY]&credentialID=[CREDENTIAL_ID]&...

JSONでレスポンスを受けるには

http://[APM Host]:[APM Port]/AppManager/json/credential?apikey=[API_KEY]&credentialID=[CREDENTIAL_ID]&...

例

http://app-windows:59090/AppManager/xml/credential?apikey=05b4a12a5fc0747cfaa897850ae9a778&credentialID=10&password=newpassword

認証情報の削除

認証情報IDの指定で、認証情報を削除できます。認証情報IDは整数にしてください

構文

XMLでレスポンスを受けるには

http://[APM Host]:[APM Port]/AppManager/xml/credential?apikey=[API_KEY]&type=[TYPE]&credentialID=[CREDENTIAL_ID]&TO_DELETE=true

JSONでレスポンスを受けるには

http://[APM Host]:[APM Port]/AppManager/json/credential?apikey=[API_KEY]&type=[TYPE]&credentialID=[CREDENTIAL_ID]&TO_DELETE=true

例

http://app-windows:59090/AppManager/xml/credential?apikey=05b4a12a5fc0747cfaa897850ae9a778&credentialID=10&TO_DELETE=true

認証情報のリストアップ

管理者はこのAPIで、Applications Managerにある認証情報をリストアップできます（JSON、XML双方）。typeは「all」とするか、特定タイプを指定するかが可能です。

構文

XMLでレスポンスを受けるには

http://[APM Host]:[APM Port]/AppManager/xml/credential/list?apikey=[API_KEY]&type=[TYPE]

JSONでレスポンスを受けるには

http://[APM Host]:[APM Port]/AppManager/json/credential/list?apikey=[API_KEY]&type=[TYPE]

例

http://app-windows:59090/AppManager/xml/credential/list?apikey=05b4a12a5fc0747cfaa897850ae9a778&type=all