B Oracle Privileged Account ManagerのRESTfulインタフェースの使用

この付録では、Oracle Privileged Account ManagerのRESTfulインタフェースについて、このインタフェースを介して公開される具体的なAPIも含めて説明します。

この付録の構成は、次のとおりです。

第B.1項「概要」
第B.2項「サーバー状態リソース」
第B.3項「コネクタ・サーバー構成リソース」
第B.4項「構成リソース」
第B.5項「ポリシー・リソース」
第B.6項「ターゲット・リソース」
第B.7項「アカウント・リソース」
第B.8項「UIリソース」
第B.9項「ユーザー・リソース」
第B.10項「グループ・リソース」
第B.11項「リソース・グループ・リソース」
第B.12項「プラグイン・リソース」

B.1 概要

Oracle Privileged Account Managerはいくつかのクライアント・インタフェースを介して使用できますが、その基本となるアクセス・メカニズムまたはレイヤーは、RESTfulインタフェースにカプセル化されています。

注意:

この付録で説明するタスクを実行するためのOracle Privileged Account ManagerのWebベース・コンソールまたはコマンド行ツールの使用方法の詳細は、第4章「Oracle Privileged Account Managerコンソールの起動と使用」または付録A「コマンド行ツールの使用」を参照してください。

外部パーティ(Oracle Privileged Account Manager以外のサーバーなど)によって使用されるOracle Privileged Account Managerサーバーとのすべての相互作用は、RESTfulインタフェースを介して公開されます。外部から参照可能なすべてのOracle Privileged Account Managerリソースは、URIでモデル化されますが、標準のHTTP操作はそれらのリソースに対する、関連するOracle Privileged Account Manager操作にマップされます。

注意:

この付録に記載されている説明は、Oracle Privileged Account ManagerをWebLogicとIBM WebSphereのどちらで使用する場合でも基本的に同じですが、少々異なる点もいくつかあります。

詳細は、『Oracle Fusion Middleware Oracle Identity and Access Managementサード・パーティ・アプリケーション・サーバー・ガイド』のIBM WebSphere上でOracle Privileged Account Managerコマンド行ツールとRESTインタフェースを使用する場合の相違点に関する項を参照してください。

B.2 サーバー状態リソース

この項では、サーバー状態の取得APIについて説明します。

B.2.1 サーバー状態の取得

このAPIを使用して、サーバーのステータスに関する情報を取得します。

URI: https://opam_server_host:opam_ssl_port/opam/
メソッド: GET
Content-Type: NA
成功時の戻り値: ステータス・コード200およびサーバー状態リソースのJSON表現

例B-1 サーバー・ステータスのサンプルJSON出力

{
    "RequestorGroups" : [
        "OPAM_APPLICATION_CONFIGURATOR",
        "OPAM_SECURITY_ADMIN",
        "OPAM_USER_MANAGER",
        "OPAM_SECURITY_AUDITOR"
    ],
    "ServerState" : {
        "Status" : "Oracle Privileged Account Manager Server is up!",
        "StatusCode" : 0
    },
    "Requestor" : "master_user"
    "version":"11.1.2.2.0"
}

{
    "ServerState" : {
        "Status" : "Oracle Privileged Account Manager Server is up!",
        "StatusCode" : 0
    },
    "Requestor" : "sec_admin",
    "RequestorGroups" : [
    "OPAM_SECURITY_ADMIN"
    ],
    version: "11.1.2.3.0",
    DelegatedPrivileges: [ ]
} 

{
   "ServerState":{
      "Status":"Oracle Privileged Account Manager Server is up!",
      "StatusCode":0
   },
   "Requestor":"weblogic",
   "RequestorGroups":[
      "Administrators"
   ],
   "version":"11.1.2.3.0",
   "DelegatedPrivileges":[
      "security_admin"
   ]
}

説明:

RequestorGroupsは、リクエストを作成しているユーザーに割り当てられているグループです。
Requestorは、リクエストを作成しているユーザーです。
StatusCodeは、サーバーが正常に動作しているかどうかを示します。
- サーバーが正常に動作している場合は、ゼロ(0)が返されます。
- なんらかの問題が発生している場合は、ゼロ以外の整数値が返されます。
Statusは、サーバーの状態に関する情報メッセージです。
versionは、Oracle Privileged Account Managerのバージョンです。
DelegatedPrivilegesは、ユーザーに委任されている管理権限です。ユーザーにリソース・グループの"security_admin"や"user_manager"などの管理権限が委任されている場合、この属性に権限が表示されます。

ユーザーに委任された管理権限がない場合、属性は空のままです(例B-1の2番目のサンプルJSON出力を参照)。

B.3 コネクタ・サーバー構成リソース

この項では、次の構成リソースAPIについて説明します。

第B.3.1項「コネクタ・サーバー構成の追加」
第B.3.2項「コネクタ・サーバー構成の検証」
第B.3.3項「コネクタ・サーバー構成の更新」
第B.3.4項「コネクタ・サーバー構成の削除」
第B.3.5項「コネクタ・サーバー構成の取得」
第B.3.6項「コネクタ・サーバー構成の検索」

B.3.1 コネクタ・サーバー構成の追加

このAPIを使用して、コネクタ・サーバー構成を追加します。

注意:

このAPIを使用するには、「アプリケーション構成者」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/connectorserver
メソッド: POST
Content-Type: application/json
本体: コネクタ・サーバーの追加またはテストのJSON表現
成功時の戻り値: ステータス・コード201 (作成済)および場所

例B-2 コネクタ・サーバー構成の追加のサンプルJSON表現

{
 "connectorserver": {
   "connectorservername": "server_test",
   "connectorserverdescription": "demo connector server in US",
   "connectorserverhost": "myhost.us.example.com",
   "connectorserverport": 8579,
   "connectorserverkey": "password2",
   "connectorserversslenabled ": true
 }
}

サンプル出力:

https://opam_server_host:opam_ssl_port/opam/connectorserver/9bbcbbb087174ad1900ea691a2573b61 as the Location

説明:

connectorservernameは、コネクタ・サーバーに付けられる名前です。
connectorserverdescriptionは、コネクタ・サーバーの説明です。このフィールドはオプションです。
connectorserverhostは、コネクタ・サーバーのホスト名です。
connectorserverportは、コネクタ・サーバーのポートです。
connectorserverkeyは、コネクタ・サーバーのキーです。
connectorserversslenabledは、コネクタ・サーバーでSSLを有効にするかどうかを示します。

B.3.2 コネクタ・サーバー構成の検証

このAPIを使用して、コネクタ・サーバー構成を追加する前に検証します。

注意:

このAPIを使用するには、「アプリケーション構成者」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/connectorserver/test
メソッド: POST
Content-Type: application/json
本体: コネクタ・サーバーの追加またはテストのJSON表現
成功時の戻り値: ステータス・コード200

例B-3 コネクタ・サーバー構成の追加のサンプルJSON表現

{
 "connectorserver": {
   "connectorservername": "server_test",
   "connectorserverdescription": "demo connector server in US",
   "connectorserverhost": "myhost.us.example.com",
   "connectorserverport": 8579,
   "connectorserverkey": "password2",
   "connectorserversslenabled ": true
 }
}

説明:

connectorservernameは、コネクタ・サーバーに付けられる名前です。
connectorserverdescriptionは、コネクタ・サーバーの説明です。このフィールドはオプションです。
connectorserverhostは、コネクタ・サーバーのホスト名です。
connectorserverportは、コネクタ・サーバーのポートです。
connectorserverkeyは、コネクタ・サーバーのキーです。
connectorserversslenabledは、コネクタ・サーバーでSSLを有効にするかどうかを示します。

B.3.3 コネクタ・サーバー構成の更新

このAPIを使用して、コネクタ・サーバー構成を更新します。

注意:

このAPIを使用するには、「アプリケーション構成者」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/connectorserver/connector_server_id
メソッド: PUT
Content-Type: application/json
本体: コネクタ・サーバーの変更のJSON表現
成功時の戻り値: ステータス・コード200

例B-4 コネクタ・サーバー構成の変更のサンプルJSON表現

{
"modifications":[
   {
       "modification": {
           "connectorserverhost": "myhost.us.example.com"
       }
   },
       {
       "modification": {
           "connectorserverport":8670
       }
   }
   ]
}

説明:

connectorserverhostは、コネクタ・サーバーのホスト名です。
connectorserverportは、コネクタ・サーバーのポートです。

B.3.4 コネクタ・サーバー構成の削除

このAPIを使用して、コネクタ・サーバー構成を削除します。

注意:

このAPIを使用するには、「アプリケーション構成者」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/connectorserver/connector_server_id
メソッド: DELETE
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200

B.3.5 コネクタ・サーバー構成の取得

このAPIを使用して、コネクタ・サーバー構成を取得します。

注意:

このAPIを使用するには、「アプリケーション構成者」、「セキュリティ管理者」または委任セキュリティ管理者の管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/connectorserver/connector_server_id
メソッド: GET
Content-Type: application/json
本体: NA
成功時の戻り値: ステータス・コード200およびコネクタ・サーバーのJSON表現

サンプル出力:

{
 "connectorserver": {
   "connectorserverid": "ab62a4b85ba34c9499794ab181d37c15",
   "connectorservername": "server_test",
   "connectorserverdescription": "demo connector server in US",
   "connectorserverhost": "myhost.us.example.com",
   "connectorserverport": 8579,
   "connectorserverkey": "password2",
   "connectorserversslenabled": true
 }
}

説明:

B.3.6 コネクタ・サーバー構成の検索

このAPIを使用して、コネクタ・サーバー構成を検索します。

注意:

URI: https://opam_server_host:opam_ssl_port/opam/connectorserver//search?param1=val1&param2=val2..
メソッド: GET
Content-Type: application/json
本体: NA
成功時の戻り値: ステータス・コード200およびコネクタ・サーバーのJSON表現

問合せパラメータには、ホスト、名前および説明を指定できます。

サンプル問合せ:

https://myhost.example.com:2001/opam/connectorserver/search?name=server&host=oracle

サンプル問合せ:

{
 "connectorservercollection": [
   {
     "connectorserver": {
       "connectorserverid": "21ae721b54854b3790214fd3fa6864df",
       "connectorservername": "server1",
       "connectorserverhost": "myhost.us.example.com",
       "connectorserverport": 180,
       "connectorserversslenabled ": true
     }
   },
   {
     "connectorserver": {
       "connectorserverid": "0a24c6287aa44d6a814b6f4deb7b751b",
       "connectorservername": "server2",
       "connectorserverhost": "myhost.us.example.com",
       "connectorserverport": 280,
       "connectorserversslenabled ": true
 
     }
   },
   {
     "connectorserver": {
       "connectorserverid": "ab62a4b85ba34c9499794ab181d37c15",
       "connectorservername": "server3",
       "connectorserverdescription": "optional description",
       "connectorserverhost": "myhost.us.example.com",
       "connectorserverport": 45,
       "connectorserversslenabled ": true
 
     }
   }
 ]
}

説明:

connectorserveridは、環境内のコネクタ・サーバーのIDです。
connectorservernameは、コネクタ・サーバーに付けられる名前です。
connectorserverdescriptionは、コネクタ・サーバーの説明です。このフィールドはオプションです。
connectorserverhostは、コネクタ・サーバーのホスト名です。
connectorserverportは、コネクタ・サーバーのポートです。
connectorserversslenabledは、コネクタ・サーバーでSSLを有効にするかどうかを示します。

B.4 構成リソース

この項では、次の構成リソースAPIについて説明します。

第B.4.1項「グローバル構成リソース」
第B.4.2項「Oracle Privileged Session Manager構成リソース」

B.4.1 グローバル構成リソース

この項では次のAPIについて説明します。

第B.4.1.1項「構成リソースの取得」
第B.4.1.2項「構成リソースの更新」

B.4.1.1 構成リソースの取得

このAPIを使用して、Oracle Privileged Account Managerの構成オブジェクトを取得します。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロール、セキュリティ管理者管理ロールまたは「アプリケーション構成者」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/config/configid
メソッド: GET
Content-Type: NA
成功時の戻り値: ステータス・コード200およびconfigオブジェクトのJSON表現

サンプルURI

https://opam_server_host:opam_ssl_port/opam/config/globalconfig

例B-5 configオブジェクトのサンプルJSON表現

{
config: {
configUID: "globalconfig",
configType: "config_globalconfig",
idstorefilter: [
"beginswith"
],
tdemode: [
"true"
],
resourceLockWaitTimeout: [
"120"
],
policyenforcerinterval: [
"3600"
],
targettimeout: [
"20"
],
passwddisplayoption: [
"showpasswd"
],
passwordcyclerinterval: [
"3600"
]
}
}

説明:

configUIDは、configオブジェクトの一意の識別子です。
configTypeは、configオブジェクトのタイプです。
policyenforcerintervalは、Oracle Privileged Account Managerがアカウントを確認し、「使用ポリシー」で定義されている有効期限を過ぎているアカウントを自動的にチェックインする時間隔(秒)です。
passwordcyclerintervalは、Oracle Privileged Account Managerがアカウントのパスワード確認し、「パスワード・ポリシー」で定義されている最大パスワード期間を超えているパスワードをリセットする時間隔(秒)です。
passworddisplayoptionは、Oracle Privileged Account Managerでアカウントのパスワードをユーザーに表示する方法を決定します。
targettimeoutは、ターゲットの接続テスト操作を実行できる許容時間(秒単位)です。
tdemodeは、Oracle Privileged Account ManagerでTDEまたは非TDEモードを使用することを求めるリクエストに対するフラグです。
resourceLockWaitTimeoutは、リソースのトランザクション・ロックを取得する操作の最大許容時間(秒単位)です。

B.4.1.2 構成リソースの更新

このAPIを使用して、Oracle Privileged Account Managerの構成オブジェクトを変更します。

注意:

このAPIを使用するには、「アプリケーション構成者」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/config/configid
メソッド: PUT
Content-Type: application/json
本体: 変更のJSON表現
成功時の戻り値: ステータス・コード200

例B-6 変更のサンプルJSON出力

{
    "modifications":[
        {
            "modification":{
                "tdemode":[
                    "false"
                ]
            }
        }
    ]
}

説明:

modificationsは、変更JSONオブジェクトの配列です。
modificationは、単一の構成オブジェクトの変更を表すJSONオブジェクトです。
tdemodeは、Oracle Privileged Account ManagerでTDEまたは非TDEモードを使用することを求めるリクエストに対するフラグです。

B.4.2 Oracle Privileged Session Manager構成リソース

この項では次のAPIについて説明します。

第B.4.2.1項「構成リソースの取得」
第B.4.2.2項「構成リソースの更新」

B.4.2.1 構成リソースの取得

このAPIを使用して、Oracle Privileged Session Managerの構成オブジェクトを取得します。

注意:

このAPIを使用するには、「ユーザー・マネージャ」、セキュリティ管理者または「アプリケーション構成者」の管理ロールを持つ管理者である必要があります。
同じマシン上でOracle Privileged Session Managerの2つのインスタンスを実行することはできません。

URI: https://opam_server_host:opam_ssl_port/opam/config/sessionmgrconfig
メソッド: GET
Content-Type: NA
成功時の戻り値: ステータス・コード200およびセッション・マネージャのconfigオブジェクトのJSON表現

例B-7 セッション・マネージャConfigのサンプルJSON表現

 {
config: {
updateinterval: 60,
maxauditthreads: 5,
maxsessions: 8192,
maxrecordsize: 10240,
restResponseTimeout: 180,
SSH: {
opamListenPort: 1222,
sessionchkoutinstructions: "ssh -p <port> <opamuser>:<targetname>:<accountname>@<sessionmgrhost> Use opam password on password prompt"
},
SMVS: {
opamListenPort: 5389,
imagestorepath: "/scratch/opam/images"
},
configUID: "sessionmgrconfig",
configType: "config_sessionmgrconfig",
windowsAgentCount: 0
}
}

説明:

configUIDは、configオブジェクトの一意の識別子です。
configTypeは、configオブジェクトのタイプです。
updateintervalは、Oracle Privileged Session Managerサーバーが、すべてのチェックアウト済セッションを確認し、それらのトランスクリプトを更新する間隔(秒単位)です。
opamserverurlsは、Oracle Privileged Session Managerが接続できるOracle Privileged Account ManagerサーバーのURLの配列です。
pub-keyは、Oracle Privileged Session Managerサーバーの公開鍵です。
maxrecordsizeは、セッションごとに許容される最大記録サイズ(KB単位)です。この割当てに達すると、そのセッションは自動的に終了します。
prv-keyは、Oracle Privileged Session Managerサーバーの秘密鍵です。

プロトコル固有の属性には次のものがあります。

opamListenPortは、プロトコルのリスナー・ポートです。
sessionchkoutinstructionsは、セッション・チェックアウトの方法です。
restResponseTimeoutは、Oracle Privileged Session ManagerがOracle Privileged Account ManagerサーバーのREST URL呼出しを実行できる最大許容時間(秒単位)です。
maxauditthreadsは、セッション・マネージャの監査プール内の最大監査スレッド数です。
maxsessionsは、セッション・マネージャ・サーバーごとの最大許容同時セッション数です。
windowAgentCountは、デプロイされるWindowsエージェント数です。

B.4.2.2 構成リソースの更新

このAPIを使用して、Oracle Privileged Session Managerの構成オブジェクトを更新します。

URI: https://opam_server_host:opam_ssl_port/opam/config/sessionmgrconfig
メソッド: PUT
Content-Type: application/json
本体: 変更のJSON表現
成功時の戻り値: ステータス・コード200

注意:

このAPIを使用するには、「アプリケーション構成者」管理ロールを持つ管理者である必要があります。

例B-8 サンプルのJSON変更

{
"modifications": [
{
"modification": {
"updateinterval": 300
}
},
{
"modification": {
"opamserverurls": [
"https://localhost:7002/opam"
]
}
},
{
"modification": {
"SSH": {
"opamListenPort": 1222
}
}
},
{
"modification": {
"SSH": {"sessionchkoutinstructions":"ssh -p <port> 
<opamuser>:<targetname>:<accountname>@<sessionmgrhost> \n Use opam password on password prompt"
}
}
}
]
}

注意:

次のものを除いて、これらのすべての属性を更新できます。

configUIDは、configオブジェクトの一意の識別子です。
configTypeは、configオブジェクトのタイプです。
WindowsAgentCountは、デプロイ済のWindowsエージェント数です。

その他の属性定義の詳細は、第B.4.2.1項「構成リソースの取得」を参照してください。

B.5 ポリシー・リソース

この項では、Oracle Privileged Account Managerのポリシーを操作する場合に使用するAPIについて説明します。

この項では次のAPIについて説明します。

第B.5.1項「ポリシーの検索」
第B.5.2項「デフォルト・ポリシーの取得」
第B.5.3項「パスワード・ポリシー・リソース」
第B.5.4項「使用ポリシー・リソース」

B.5.1 ポリシーの検索

このAPIを使用して、ポリシーを検索します。このAPIは、次のパラメータを1つ以上使用した検索です。

policystatus
policyname

パラメータはすべてオプションです。

URI: https://opam_server_host:opam_ssl_port/opam/policy/search?param1=val1&param2=val2
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびポリシーのJSON表現

例B-9 ポリシーのサンプルJSON表現

{
   "usagepolicies":[
      {
         "policyname":"Default Usage Policy",
         "policyid":"usagepolicy1",
         "policystatus":"active",
      }
   ],
   "passwordpolicies":[
      {
         "policyname":"Default Password Policy",
         "policyid":"passwordpolicy2",
         "policystatus":"active",
         "globaldefault":"y"
      }
   ]
}

説明:

usagepoliciesは、使用ポリシーの配列です。
passwordpoliciesは、パスワード・ポリシーの配列です。
policynameは、ポリシー名です。
policyidは、ポリシーの一意識別子です。
policystatusは、ポリシー・ステータスであり、有効な値はactiveまたはdisabledです。

B.5.2 デフォルト・ポリシーの取得

このAPIを使用して、デフォルト使用ポリシーおよびデフォルト・パスワード・ポリシーを取得します。

URI: https://opam_server_host:opam_ssl_port/opam/policy/default
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびポリシーのJSON表現

例B-10 ポリシーのサンプルJSON表現

{
   "usagepolicies":[
      {
         "policyname":"Default Usage Policy",
         "policyid":"usagepolicy1",
         "policystatus":"active"
      }
   ],
   "passwordpolicies":[
      {
         "policyname":"Default Password Policy",
         "policyid":"passwordpolicy2",
         "policystatus":"active"
      }
   ]
}

説明:

usagepoliciesは、使用ポリシーの配列です。
passwordpoliciesは、パスワード・ポリシーの配列です。
policynameは、ポリシー名です。
policyidは、ポリシーの一意識別子です。
policystatusは、ポリシー・ステータスであり、有効な値はactiveまたはdisabledです。

この属性は、デフォルト・ポリシー(デフォルト使用ポリシーおよびデフォルト・パスワード・ポリシー)のみを返します。

B.5.3 パスワード・ポリシー・リソース

この項では次のAPIについて説明します。

第B.5.3.1項「パスワード・ポリシーの取得」
第B.5.3.2項「パスワード・ポリシーの更新」
第B.5.3.3項「パスワード・ポリシーの作成」
第B.5.3.4項「パスワード・ポリシーのアカウントの取得」
第B.5.3.5項「パスワード・ポリシーの削除」

B.5.3.1 パスワード・ポリシーの取得

このAPIを使用してパスワード・ポリシーを取得します。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロールまたはセキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/passwordpolicy/{policyid}
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびパスワード・ポリシーのJSON表現

例B-11 パスワード・ポリシーのサンプルJSON表現

{
   "passwordpolicy":{
      "policyid":"passwordpolicy2",
      "policystatus":"active",
      "policyname":"Default Password Policy",
      "description":"Default Password Policy",
      "globaldefault":"y",
      "passwordchangedurationunit":"days",
      "passwordchangedurationvalue":30,
      "passwordhistorydays":30
      "changeoncheckin":"y",
      "changeoncheckout":"y",
      "passwordcharsmin":8,
      "passwordcharsmax":8,
      "passwordalphabeticmin":1,
      "passwordnumericmin":1,
      "passwordalphanumericmin":2,
      "passworduniquemin":1,
      "passworduppercasemin":1,
      "passwordlowercasemin":1,
      "passwordspecialmin":0,
      "passwordspecialmax":0,
      "passwordrepeatedmin":0,
      "passwordrepeatedmax":1,
      "startingchar":"n",
      "isaccountnameallowed":"n",
      "requiredchars":[
         "a",
         "h",
         "j"
      ],
      "allowedchars":[
         "b",
         "t",
         "y",
         "p",
         "u",
         "r",
         "o",
         "k",
         "1",
         "2",
         "=",
         "M",
         "a",
         "h",
         "j"
      ],
      "disalloweddchars":[
         "7",
         "8",
         "l"
      ],
   }
}

説明:

passwordpolicyは、パスワード・ポリシーJSONオブジェクトです。
policyidは、ポリシーの一意識別子です。
policystatusは、ポリシー・ステータスであり、有効な値はactiveまたはdisabledです。
policynameは、ポリシー名です。
descriptionは、ポリシーの説明です。
globaldefaultは、ポリシーがグローバル・デフォルトであるかどうかを示します。
passwordchangedurationunitおよびpasswordchangedurationvalueは、アカウント・パスワードの変更が必要となる時間隔を決定します。この場合、passwordchangedurationunitには、値days、hoursまたはminutesを指定できます。
passwordhistorydaysは、パスワード履歴を保持する日数を示します。
changeoncheckinは、チェックイン時にパスワードを変更するかどうかを示します。有効な値はyおよびn.です。
changeoncheckoutは、チェックアウト時にパスワードを変更するかどうかを示します。有効な値はyおよびn.です。
startingcharは、パスワードの先頭の文字を示します。
isaccountnameallowedは、パスワードをアカウント名と同じにできるかどうかを示します。
requiredchars、allowedchars、disallowedcharsは、それぞれ、必要な文字、許可されている文字および許可されていない文字です。
passwordcharsminは、パスワードに必要な最小文字数です。
passwordcharsmaxは、パスワードに使用できる最大文字数です。
passwordalphabeticminは、パスワードに必要なアルファベット文字の最小数です。
passwordnumericminは、パスワードに必要な数字の最小数です。
passwordalphanumericminは、パスワードに必要な英数字の最小数です。
passworduniqueminは、パスワードに必要な一意文字の最小数です。
passworduppercaseminは、パスワードに必要な大文字の最小数です。
passwordlowercaseminは、パスワードに必要な小文字の最小数です。
passwordspecialminは、パスワードに必要な特殊文字の最小数です。
passwordspecialmaxは、パスワードに使用できる特殊文字の最大数です。
passwordrepeatedminは、パスワードに必要な繰返し文字の最小数です。
passwordrepeatedmaxは、パスワードに使用できる繰返し文字の最大数です。

B.5.3.2 パスワード・ポリシーの更新

このAPIを使用して使用ポリシーを更新します。policyidを除くすべての属性の更新が可能で、同時に複数の属性を更新できます。

注意:

このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/passwordpolicy/{policyid}
メソッド: PUT
Content-Type: application/json
本体: パスワード・ポリシーの変更のJSON表現
成功時の戻り値: ステータス・コード200

例B-12 パスワード・ポリシーの変更のサンプルJSON表現

{
   "modifications":[
      {
         "modification":{
            "disalloweddchars":[
               "4",
               "6"
            ]
         }
      },
      {
         "modification":{
            "passwordalphabeticmin":2
         }
      }
   ]
}

説明:

modificationsは、変更JSONオブジェクトの配列です。
modificationは、単一属性を表すJSONオブジェクトです。

B.5.3.3 パスワード・ポリシーの作成

このAPIを使用してパスワード・ポリシーを作成します。

注意:

このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/passwordpolicy
メソッド: POST
Content-Type: application/json
本体: パスワード・ポリシーの作成のJSON表現
成功時の戻り値: ステータス・コード201

例B-13 パスワード・ポリシーの作成のサンプルJSON表現

{
   "passwordpolicy":{
      "policystatus":"active",
      "policyname":"Custom Password Policy",
      "description":"Default Password Policy",
      "passwordchangedurationunit":"days",
      "passwordchangedurationvalue":30,
      "passwordhistorydays":30,
      "changeoncheckin":"y",
      "changeoncheckout":"y",
      "passwordcharsmin":8,
      "passwordcharsmax":8,
      "passwordalphabeticmin":1,
      "passwordnumericmin":1,
      "passwordalphanumericmin":2,
      "passworduniquemin":1,
      "passworduppercasemin":1,
      "passwordlowercasemin":1,
      "passwordspecialmin":0,
      "passwordspecialmax":0,
      "passwordrepeatedmin":0,
      "passwordrepeatedmax":1,
      "startingchar":"n",
      "isaccountnameallowed":"n",
      "requiredchars":[
         "a",
         "h",
         "j"
      ],
      "allowedchars":[
         "b",
         "t",
         "y",
         "p",
         "u",
         "r",
         "o",
         "k",
         "1",
         "2",
         "=",
         "M",
         "a",
         "h",
         "j"
      ],
      "disalloweddchars":[
         "7",
         "8",
         "l"
      ]
   }
}

policynameを除き、属性はすべてオプションlです。属性定義の詳細は、第B.5.3.1項「パスワード・ポリシーの取得」を参照してください。

B.5.3.4 パスワード・ポリシーのアカウントの取得

このAPIを使用してパスワード・ポリシーのアカウント・リストを取得します。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロールまたはセキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/passwordpolicy/{policyid}/accounts
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびアカウントのJSON表現

例B-14 アカウントのサンプルJSON表現

{
    "accounts":[
        {
            "account":{
                "accountUID":"5bb2c74e1655487c92ecefd5b5270e95",
                "accountName":"dsperson1",
                "targetID":"3ba06e568166493384f86aa5cc7152f1",
                "targetName":"sunds_6.3_target",
                "targetDomain":"needtofix",
                "targetType":"ldap"
                }
        },
        {
            "account":{
               "account":{
                    "accountUID":"c67f93d7a7e44844b24aa43d4cd236e9",
                    "accountName":"person2",
                    "targetID":"75a23e9f30ba456b961a1f5d327e67ef",
                    "targetName":"ldap1_target",
                    "targetDomain":"needtofix",
                    "targetType":"ldap"
                    }
               }
        }
     ]
}

属性定義の詳細は、第B.6項「ターゲット・リソース」および第B.7項「アカウント・リソース」を参照してください。

B.5.3.5 パスワード・ポリシーの削除

このAPIを使用してパスワード・ポリシーを削除します。

注意:

このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/passwordpolicy/{policyid}
メソッド: DELETE
Content-Type: NA
本体: NA
成功時の戻り値: ステータス200

B.5.4 使用ポリシー・リソース

この項では次のAPIについて説明します。

第B.5.4.1項「使用ポリシーの取得」
第B.5.4.2項「使用ポリシーの更新」
第B.5.4.3項「使用ポリシーの作成」
第B.5.4.4項「使用ポリシーの権限付与の取得」
第B.5.4.5項「使用ポリシーの削除」

B.5.4.1 使用ポリシーの取得

このAPIを使用して使用ポリシーを取得します。

URI: https://opam_server_host:opam_ssl_port/opam/usagepolicy/{policyid}
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200および使用ポリシーのJSON表現

例B-15 使用ポリシーのサンプルJSON表現

{
   "usagepolicy":{
      "policyid":"usagepolicy1",
      "policystatus":"active",
      "policyname":"Default Usage Policy",
      "description":"Default Usage Policy",
      "globaldefault":"y",
      "dateorduration":"duration",
      "expireddateminutesfromcheckout":7200,
      "expireddate":"08\/08\/2088",
      "expireddatehour":0,
      "expireddateminutes":0,
      "expireddateamorpm":"am",
      "timezone":"America\/Los_Angeles",
      "usagedates":[
         {
            "day":"saturday",
            "fromhour":"12",
            "fromminutes":"0",
            "fromamorpm":"am",
            "tohour":"12",
            "tominutes":"0",
            "toamorpm":"am"
         },
         {
            "day":"wednesday",
            "fromhour":"12",
            "fromminutes":"0",
            "fromamorpm":"am",
            "tohour":"12",
            "tominutes":"0",
            "toamorpm":"am"
         },
         {
            "day":"sunday",
            "fromhour":"12",
            "fromminutes":"0",
            "fromamorpm":"am",
            "tohour":"12",
            "tominutes":"0",
            "toamorpm":"am"
         },
         {
            "day":"friday",
            "fromhour":"12",
            "fromminutes":"0",
            "fromamorpm":"am",
            "tohour":"12",
            "tominutes":"0",
            "toamorpm":"am"
         },
         {
            "day":"tuesday",
            "fromhour":"12",
            "fromminutes":"0",
            "fromamorpm":"am",
            "tohour":"12",
            "tominutes":"0",
            "toamorpm":"am"
         },
         {
            "day":"thursday",
            "fromhour":"12",
            "fromminutes":"0",
            "fromamorpm":"am",
            "tohour":"12",
            "tominutes":"0",
            "toamorpm":"am"
         },
         {
            "day":"monday",
            "fromhour":"12",
            "fromminutes":"0",
            "fromamorpm":"am",
            "tohour":"12",
            "tominutes":"0",
            "toamorpm":"am"
         }
         ],
      "allowcheckouttype":"all",
      "scp":{  
         "enable":true
      },
      "ssh":{  
         "enableInteractive":true,
         "enableNonInteractive":true,
         "enableCommandLogging":true,
         "commandControl":{  
            "listType":"whitelist",
            "listValues":[  
               "cd",
               "ls"
            ]
         },
         "commandReplacements":[  
            {  
               "original":"setenv",
               "replaceWith":"set"
            },
            {  
               "original":"history",
               "replaceWith":"safehistory"
            }
         ]
      }
   }
}

説明:

usagepolicyは、使用ポリシーJSONオブジェクトです。
policyidは、使用ポリシーの一意識別子です。
policystatusは、activeまたはdisabledに設定されます。
policynameは、ポリシーの名前です。
descriptionは、ポリシーの説明です。
globaldefaultは、ポリシーがグローバル・デフォルト・ポリシーであるかどうかを示します。
dateordurationは、有効期限の計算方法を示します。
- 設定がdateの場合、expireddate、expireddatehour、expireddateminutesおよびexpireddateamorpmが使用されます。
- 設定がdurationの場合、expireddateminutesfromcheckoutが使用されます。
説明:
- expireddateは有効期限の日付です。書式はMM/dd/yyyyです。
- expireddatehour.hourは0から12の整数値です。
- expireddateminutes.minutesは0から60の整数値です。
- expireddateamorpmはamまたはpmです。
- expireddateminutesfromcheckoutはチェックアウトからの分数です。
timezoneは、使用ポリシーのタイムゾーンです。
usagedatesは、配列であり、各値が個々の日のチェックアウト時刻を表します。
dayは、曜日であり、有効な値はsunday、monday、tuesday、wednesday、thursday、fridayおよびsaturdayです。

次の属性を使用して範囲の開始と終了を示します。

fromhourは、0から12の整数値です。
fromminutesは、0から60の整数値です。
fromamorpmは、amまたはpmです。
tohourは、0と12の間の整数値nです。
tominutesは、0から60の整数値です。
toamorpmは、amまたはpmです。
allowcheckoutypeは、そのポリシーに対してどのタイプのチェックアウトが許可されるのかを示します。
- all: このオプションを選択すると、ユーザーにパスワードおよびセッションのチェックアウトが許可されます。
- password (デフォルト): このオプションを選択すると、ユーザーにパスワードのチェックアウトのみが許可されます。
- session: このオプションを選択すると、ユーザーにセッションのチェックアウトのみが許可されます。
scpは、SCP固有の属性を持つJSONオブジェクトです。
- enableは、SCPを有効にするかどうかを指定します。
sshは、SSH固有の属性を持つJSONオブジェクトです。
enableInteractiveは、対話型アクセスにSSHを有効にするかどうかを指定します。これは、デフォルトがtrueのブール型です。
enableNonInteractiveは、非対話型アクセスにSSHを有効にするかどうかを指定します。これは、デフォルトがtrueのブール型です。
enableCommandLoggingは、コマンド・ロギングを有効にするかどうかを指定します。コマンド・ロギングを使用すると、監査者はセッション記録を対話型トランスクリプトとして表示できます。
commandControlは、コマンド制御の制約を指定する属性を持つJSONオブジェクトです。
listTypeは、コマンド制御用に指定されたリストがホワイトリスト(whitelist)またはブラックリスト(blacklist)のどちらであるかを指定します。許可された値のみが"whitelist"または"blacklist"とみなされます。空の文字列("")が表示された場合は、リストが無視されたことを示します。
listValueは、コマンドの正規表現の配列です。
commandReplacementsは、コマンドとその代替コマンドの配列です。デフォルトで、このリストは空です。
originalは、代替コマンドを特定する際に照合するコマンド名です。
replaceWithは、元のコマンドを置換する代替コマンドです。

B.5.4.2 使用ポリシーの更新

このAPIを使用して使用ポリシーを更新します。policyidを除くすべての属性の更新が可能で、同時に複数の属性を更新できます。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロールまたはセキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/usagepolicy/{policyid}
メソッド: PUT
Content-Type: application/json
本体: 使用ポリシーの変更のJSON表現
成功時の戻り値: ステータス・コード200

例B-16 使用ポリシーの変更のサンプルJSON表現

{
   "modifications":[
      {
         "modification":{
            "usagedates":[
               {
                  "day":"saturday",
                  "fromhour":"12",
                  "fromminutes":"0",
                  "fromamorpm":"am",
                  "tohour":"12",
                  "tominutes":"0",
                  "toamorpm":"am"
               },
               {
                  "day":"wednesday",
                  "fromhour":"12",
                  "fromminutes":"0",
                  "fromamorpm":"am",
                  "tohour":"12",
                  "tominutes":"0",
                  "toamorpm":"am"
               }
            ]
         }
      },
      {
         "modification":{
            "expireddatehour":2
         }
      },
      {
         "modification":{
            "scp":{
               "enable":false
            }
         }
      },
      {
         "modification":{
            "ssh":{
               "commandControl":{
                  "listValues":[
                     "cd",
                     "ls.*"
                  ]
               }
            }
         }
      },
      {
         "modification":{
            "ssh":{
               "commandReplacements":[
                  {
                     "original":"setenv",
                     "replaceWith":"set"
                  }
               ]
            }
         }
      }
   ]
}

説明:

modificationsは、変更JSONオブジェクトの配列です。
modificationは、単一属性を表すJSONオブジェクトです。

B.5.4.3 使用ポリシーの作成

このAPIを使用して使用ポリシーを作成します。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロールまたはセキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/usagepolicy
メソッド: POST
Content-Type: application/json
本体: 使用ポリシーの作成のJSON表現
成功時の戻り値: ステータス・コード201
SCP: true/false
SSH: true/false

例B-17 使用ポリシーの作成のサンプルJSON表現

{
   "usagepolicy":{
      "policystatus":"active",
      "policyname":"Custom Usage Policy",
      "description":"Custom Usage Policy",
      "globaldefault":"y",
      "dateorduration":"duration",
      "expireddateminutesfromcheckout":7200,
      "expireddate":"08\/08\/2088",
      "expireddatehour":0,
      "expireddateminutes":0,
      "expireddateamorpm":"am",
      "timezone":"America\/Los_Angeles",
      "usagedates":[
         {
            "day":"saturday",
            "fromhour":"12",
            "fromminutes":"0",
            "fromamorpm":"am",
            "tohour":"12",
            "tominutes":"0",
            "toamorpm":"am"
         },
         {
            "day":"wednesday",
            "fromhour":"12",
            "fromminutes":"0",
            "fromamorpm":"am",
            "tohour":"12",
            "tominutes":"0",
            "toamorpm":"am"
         },
         {
            "day":"sunday",
            "fromhour":"12",
            "fromminutes":"0",
            "fromamorpm":"am",
            "tohour":"12",
            "tominutes":"0",
            "toamorpm":"am"
         },
         {
            "day":"friday",
            "fromhour":"12",
            "fromminutes":"0",
            "fromamorpm":"am",
            "tohour":"12",
            "tominutes":"0",
            "toamorpm":"am"
         },
         {
            "day":"tuesday",
            "fromhour":"12",
            "fromminutes":"0",
            "fromamorpm":"am",
            "tohour":"12",
            "tominutes":"0",
            "toamorpm":"am"
         },
         {
            "day":"thursday",
            "fromhour":"12",
            "fromminutes":"0",
            "fromamorpm":"am",
            "tohour":"12",
            "tominutes":"0",
            "toamorpm":"am"
         },
         {
            "day":"monday",
            "fromhour":"12",
            "fromminutes":"0",
            "fromamorpm":"am",
            "tohour":"12",
            "tominutes":"0",
            "toamorpm":"am"
         }
         ],
      "allowcheckouttype":"all",
      "scp":{
         "enable":true
      },
      "ssh":{
         "enableInteractive":true,
         "enableNonInteractive":true,
         "enableCommandLogging":true,
         "commandControl":{
            "listType":"whitelist",
            "listValues":[
               "cd",
               "ls"
            ]
         },
         "commandReplacements":[
            {
               "original":"setenv",
               "replaceWith":"set"
            },
            {
               "original":"history",
               "replaceWith":"safehistory"
            }
         ]
      }
   }
}

属性定義の詳細は、第B.5.4.1項「使用ポリシーの取得」を参照してください。

B.5.4.4 使用ポリシーの権限付与の取得

このAPIを使用して、使用ポリシーの権限付与のリストを取得します。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロールまたはセキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/usagepolicy/{policyid}/grantees
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200および権限付与のJSON表現

例B-18 権限付与のサンプルJSON表現

{
    "grantees":[
        {
            "grantee":{
            "accountUID":"16d245784350469cbe25229a7c45af22",
            "accountName":"oidperson10",
            "targetID":"75a23e9f30ba456b961a1f5d327e67ef",
            "targetName":"ldap1_target",
            "targetDomain":"needtofix",
            "targetType":"ldap",
            "grantee":"CrossDomainConnectors",
            "grantType":"role"
            }
        },
        {
            "grantee":{
            "accountUID":"3a7f105a1e45407284cd887f8774700d",
            "accountName":"openLDAPperson2",
            "targetID":"dd9d7a31b39348c79eb23ac46f04d40d",
            "targetName":"openldap_2.3_target",
            "targetDomain":"needtofix",
            "targetType":"ldap",
            "grantee":"opamuser2",
            "grantType":"user"
            }
        }
    ]
}

属性定義の詳細は、第B.6項「ターゲット・リソース」および第B.7項「アカウント・リソース」を参照してください。

B.5.4.5 使用ポリシーの削除

このAPIを使用して使用ポリシーを削除します。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロールまたはセキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/usagepolicy/{policyid}
メソッド: DELETE
Content-Type: NA
本体: NA
成功時の戻り値: ステータス200

B.6 ターゲット・リソース

この項では次のAPIについて説明します。

第B.6.1項「ターゲット属性の取得」
第B.6.2項「ターゲットの追加」
第B.6.3項「ターゲットの検証」
第B.6.4項「ターゲットの取得」
第B.6.5項「ターゲットの更新」
第B.6.6項「ターゲットの削除」
第B.6.7項「ターゲットの検索」
第B.6.8項「使用可能なアカウントの取得」
第B.6.9項「ターゲットで登録されているアカウントの取得」
第B.6.10項「ターゲット・タイプの取得」
第B.6.11項「パスワードのリセット」
第B.6.12項「サービス・アカウント・パスワードの表示」
第B.6.13項「サービス・アカウント・パスワードの表示(非推奨)」
第B.6.14項「サービス・アカウント・パスワード履歴の表示」

B.6.1 ターゲット属性の取得

このAPIを使用して、すべてのターゲット・タイプに関連付けられた属性のリストを取得します。

サポートされるターゲット・タイプのリストをこれらの属性とともに使用して、ターゲットを追加するために必要なJSONオブジェクトを作成します。詳細は、第B.6.2項「ターゲットの追加」を参照してください。

URI: https://opam_server_host:opam_ssl_port/opam/target/attributes
メソッド: GET
Content-Type: NA
成功時の戻り値: ステータス・コード200、ターゲット・タイプのJSON表現、およびそれらに関連付けられた属性

サンプルURI

https://opam_server_host:opam_ssl_port/opam/target/attributes

例B-19 サポートされているターゲット・タイプと属性のJSON表記の出力

{
   "TargetAttributes":[
      {
         "TargetType":"ldap",
         "DisplayName":"ldap",
         "Remote":false,
         "BasicAttributes":[
            {
               "name":"targetName",
               "type":"string",
               "description":"",
               "label":"Name",
               "mask":"false",
               "array":"false",
               "required":"true"
               "readonly":"false"
            },
            {
               "name":"description",
               "type":"string",
               "description":"",
               "label":"Description",
               "mask":"false",
               "array":"false",
               "required":"false"
            },
            {
               "name":"organization",
               "type":"string",
               "description":"",
               "label":"Organization",
               "mask":"false",
               "array":"false",
               "required":"false"
            },
            {
               "name":"domain",
               "type":"string",
               "description":"",
               "label":"Domain",
               "mask":"false",
               "array":"false",
               "required":"true"
            },
            {
               "name":"host",
               "type":"string",
               "description":"",
               "label":"Host",
               "mask":"false",
               "array":"false",
               "required":"true"
            },
            {
               "name":"port",
               "type":"int",
               "description":"TCP/IP port number used to communicate with the LDAP server.",
               "label":"TCP Port",
               "default":"",
               "mask":"false",
               "array":"false",
               "required":"true"
            },
            {
               "name":"ssl",
               "type":"boolean",
               "description":"Select the check box to connect to the LDAP server using SSL.",
               "label":"SSL",
               "default":"false",
               "mask":"false",
               "array":"false",
               "required":"true"
            },
            {
               "name":"principal",
               "type":"string",
               "description":"The distinguished name with which to authenticate
                  to the LDAP server.",
               "label":"Principal",
               "default":"",
               "mask":"false",
               "array":"false",
               "required":"true"
            },
            {
               "name":"credentials",
               "type":"string",
               "description":"Password for the principal.",
               "label":"Password",
               "default":"",
               "mask":"true",
               "array":"false",
               "required":"true"
            },
            {
               "name":"baseContexts",
               "type":"string",
               "description":"One or more starting points in the LDAP tree that will be used 
                  when searching the tree. Searches are performed when discovering users from 
                  the LDAP server or when looking for the groups of which a user is a member.",
               "label":"Base Contexts",
               "default":[
 
               ],
               "mask":"false",
               "array":"true",
               "required":"true"
            },
            {
               "name":"accountNameAttribute",
               "type":"string",
               "description":"Attribute which holds the account's user name.",
               "label":"Account User Name Attribute",
               "default":"uid",
               "mask":"false",
               "array":"false",
               "required":"true"
            }
         ],
         "AdvancedAttributes":[
            {
               "name":"uidAttribute",
               "type":"string",
               "description":"The name of the LDAP attribute which is mapped
                  to the Uid attribute.",
               "label":"Uid Attribute",
               "default":"uid",
               "mask":"false",
               "array":"false",
               "required":"false"
            },
            {
               "name":"accountSearchFilter",
               "type":"string",
               "description":"An optional LDAP filter to control which accounts are returned 
                  from the LDAP resource. If no filter is specified, only accounts that include 
                  all specified object classes are returned.",
               "label":"LDAP Filter for Retrieving Accounts",
               "default":"(uid=*)",
               "mask":"false",
               "array":"false",
               "required":"false"
            },
            {
               "name":"passwordAttribute",
               "type":"string",
               "description":"The name of the LDAP attribute which holds the password. 
                  When changing an user's password, the new password is set to this attribute.",
               "label":"Password Attribute",
               "default":"userpassword",
               "mask":"false",
               "array":"false",
               "required":"false"
            },
            {
               "name":"accountObjectClasses",
               "type":"string",
               "description":"The object class or classes that will be used when 
                  creating new user objects in the LDAP tree. When entering more than one 
                  object class, each entry should be on its own line; do not use commas or
                  semi-colons to separate multiple object classes. Some object classes 
                  may require that you specify all object classes in the class hierarchy.",
               "label":"Account Object Classes",
               "default":[
                  "top",
                  "person",
                  "organizationalPerson",
                  "inetOrgPerson"
               ],
               "mask":"false",
               "array":"true",
               "required":"false"
            }
         ]
      }
   ]
}

説明:

TargetAttributesは、オブジェクトの配列であり、各オブジェクトがターゲット・タイプを表します。
TargetTypeは、ターゲット・タイプです。
DisplayNameは、ターゲット・タイプ名の表示方法です。
BasicAttributesは、オブジェクトの配列であり、各オブジェクトがターゲット・タイプの基本属性を表します。
AdvancedAttributesは、オブジェクトの配列であり、各オブジェクトがターゲット・タイプの拡張属性を表します。
nameは、ターゲットJSONを構成してターゲットを作成する場合に使用する属性名です。
typeは、属性タイプです。有効な値は、string、int、booleanまたはlov (値リスト)です。
descriptionは、属性のわかりやすい説明です。
labelは、属性名の表示方法です。
defaultは、属性のデフォルト値です。

arrayパラメータがfalseの場合は単一値を指定し、arrayがtrueの場合は値の配列を指定します。
maskは、資格証明などの機密値を非表示にします。
- 属性を非表示にする場合、trueを指定します。
- 属性を非表示にする必要がない場合、falseを指定します。
arrayは、属性が単一値であるか複数値の配列であるかを示します。
- 属性が複数値の配列である場合、trueを指定します。
- 属性が単一値の場合、falseを指定します。
requiredは、属性が必須であるかオプションであるかを示します。
- 必須属性の場合、trueを指定します。
- オプション属性の場合、falseを指定します。
Remoteは、このターゲット・タイプがコネクタ・サーバーでサポートされているかどうかを示します。

B.6.2 ターゲットの追加

このAPIを使用してターゲットを追加します。

注意:

このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。
最初に、第B.6.1項「ターゲット属性の取得」の説明に従ってターゲット・タイプの属性のリストを取得する必要があります。これらの属性を使用して、本体で送信されるJSONオブジェクトを作成します。

URI: https://opam_server_host:opam_ssl_port/opam/target
メソッド: POST
Content-Type: application/json
本体: ターゲットの追加またはテストのJSON表現
成功時の戻り値: ステータス・コード201 (作成済)および場所

例B-20 ターゲットの追加のサンプルJSON表現(ldap TargetType)

{
   "target":{
      "targetType":"ldap",
      "targetName":"ldap1-target",
      "host":"opam_server_host",
      "passwordpolicy":"712375b4b7bb453c9482d02535989b53",
      "domain":"berkeley",
      "description":"Ldap target",
      "organization":"ST-US",
      "credentials":"welcome",
      "uidAttribute":"uid",
      "port":"9876",
      "passwordAttribute":"userpassword",
      "principal":"cn=orcladmin",
      "accountSearchFilter":"(uid=*)",
      "baseContexts":[
         "cn=Users,c=US"
      ],
      "ssl":"false",
      "accountObjectClasses":[
         "top",
         "person",
         "organizationalPerson",
         "inetOrgPerson"
      ],
      "accountNameAttribute":"uid"
   }
}

例B-21 ターゲットの追加のサンプルJSON表現(lockbox TargetType)

{
    "target" : {
        "targetUID" : "62bcfb98f95174ad1900ea2535989b53",
        "targetType" : "targetType",
        "targetName" : "lockbox_target",
        "passwordpolicy" : "passwordpolicy1",
        "passwordchgtime" : "2015-01-12 11:59:39.935",
        "host" : "myhost.us.example.com",
        "domain" : "",
        "description" : "",
        "connectorserverid" : "",
        "targetCustomAttrs      ":[{"targetCustomAttr" : {
        "attrname" : "attr1"
        "attrvalue" : ["value1"]
         }}]

    }
}

例B-22 ターゲットの追加のサンプルJSON表現(database TargetType)

{
    "target" : {
        "targetType" : "database",
        "targetName" : "db1_target",
        "passwordpolicy" : "712375b4b7bb453c9482d02535989b53",
        "passwordrollover" : "true",
        "host" : "afg1140282",
        "domain" : "adc1140282Domain",
        "description" : "Dbase target for the automation",
        "connectionProperties" : "",
        "dbType" : "Oracle",
        "jdbcUrl" : "jdbc:oracle:thin:@afg1140282.pk.com:11227:db5474",
        "loginPassword" : "password1",
        "loginUser" : "system"
    }
}

例B-23 ターゲットの追加のサンプルJSON表現(unix TargetType)

{
    "target" : {
        "targetType" : "unix",
        "targetName" : "BackUpUnixTarget",
        "passwordpolicy" : "712375b4b7bb453c9482d02535989b53",
        "passwordrollover" : "true",
        "host" : "myhost.us.example.com",
        "domain" : "US",
        "description" : "Backup system",
        "organization" : "IT",
        "port" : "23",
        "sudoPasswdExpectExpression" : "password",
        "commandTimeout" : "120000",
        "passwordExpectExpressions" :
         "new[\\s](unix[\\s])?password:,new[\\s](unix[\\s])?password([\\s]again)?:",
        "loginShellPrompt" : "$",
        "prePasswdExpectExpression" : "None",
        "sudoAuthorization" : "false",
        "loginUserpassword" : "password1",
        "loginUser" : "aime2"
    }
}

例B-24 ターゲットの追加のサンプルJSON表現(windows TargetType)

{
  "target":{
    "targetType":"windows",
    "targetName":"Windows7Target",
    "connectorserverid":"52d42cf5346f46449a565939dce61d05",
    "passwordpolicy":"9a565939d6f46449a5659352d42cf53",
    "passwordrollover":"false",
    "host":"myhost.us.example.com",
    "domain":"US",
    "description":"Windows7 target system",
    "organization" : "IT",
    "AdminPassword":"password1",
    "AdminName":"MYHOST\Administrator"
  }
}

サンプル出力

https://opam_server_host:opam_ssl_port/opam/target
/9bbcbbb087174ad1900ea691a2573b61 (場所)

説明:

targetは、ターゲットJSONオブジェクトです。
targetNameは、ターゲットの名前です。
targetTypeは、ターゲット・タイプです。
passwordpolicyは、ターゲットに適用されているパスワード・ポリシーのパスワード・ポリシーIDです。
passwordrolloverは、ターゲットのサービス・アカウント用の自動パスワード・リサイクルを有効にするかどうかを示すフラグです。

このフラグをtrueに設定すると、Oracle Privileged Account Managerによって、適用されているパスワード・ポリシーで指定されている設定に基づいてターゲットのサービス・アカウント・パスワードが自動的にリセットされます。

注意:
passwordrolloverフラグは、ldapとlockboxのどちらのターゲットに対しても現在サポートされていません。
connectorserveridは、ターゲットに関連付けられているコネクタ・サーバーを示します。ローカル・バンドルjarを使用しているターゲットの場合、connectorserveridは空になり、("")と表示されます。

他のすべての属性は、動的であり、第B.6.1項「ターゲット属性の取得」の属性に対応します。

B.6.3 ターゲットの検証

このAPIを使用してターゲットを検証します。

注意:

最初に、ターゲット・タイプの属性のリストを取得する必要があります。本体で送信されるJSONオブジェクトを作成するには、第B.6.1項「ターゲット属性の取得」を参照してください。

URI: https://opam_server_host:opam_ssl_port/opam/target/test
メソッド: PUT
Content-Type: application/json
本体: ターゲットの追加またはテストのJSON表現
成功時の戻り値: ステータス・コード200

例B-25 ターゲットの追加または検証のサンプルJSON表現

{
   "target":{
      "targetType":"ldap",
      "targetName":"ldap1-target",
      "host":"opam_server_host",
      "passwordpolicy":"712375b4b7bb453c9482d02535989b53",
      "domain":"berkeley",
      "description":"Ldap target",
      "organization":"ST-US",
      "credentials":"welcome",
      "uidAttribute":"uid",
      "port":"9876",
      "passwordAttribute":"userpassword",
      "principal":"cn=orcladmin",
      "accountSearchFilter":"(uid=*)",
      "baseContexts":[
         "cn=Users,c=US"
      ],
      "ssl":"false",
      "accountObjectClasses":[
         "top",
         "person",
         "organizationalPerson",
         "inetOrgPerson"
      ],
      "accountNameAttribute":"uid"
   }
}

説明:

targetは、ターゲットJSONオブジェクトです。
targetNameは、ターゲットの名前です。
targetTypeは、ターゲット・タイプです。
passwordpolicyは、ターゲットに適用されているパスワード・ポリシーのパスワード・ポリシーIDです。

他のすべての属性は、動的であり、第B.6.1項「ターゲット属性の取得」の属性に対応します。

B.6.4 ターゲットの取得

このAPIを使用してターゲットを取得します。

URI: https://opam_server_host:opam_ssl_port/opam/target/{targetUID}
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびターゲットのJSON表現

例B-26 ターゲットのサンプルJSON表現(ldapターゲット・タイプ)

{
   "target":{
      "targetUID":"62bcfb98f95174ad1900ea2535989b53",
      "targetType":"ldap",
      "targetName":"ldap1-target",
      "host":"opam_server_host",
      "domain":"berkeley",
      "description":"Ldap target",
      "organization":"ST-US",
      "credentials":"welcome",
      "uidAttribute":"uid",
      "port":"9876",
      "passwordAttribute":"userpassword",
      "principal":"cn=orcladmin",
      "accountSearchFilter":"(uid=*)",
      "baseContexts":[
         "cn=Users,c=US"
      ],
      "ssl":"false",
      "accountObjectClasses":[
         "top",
         "person",
         "organizationalPerson",
         "inetOrgPerson"
      ],
      "accountNameAttribute":"uid",
   }
}

例B-27 ターゲットのサンプルJSON表現(databaseターゲット・タイプ)

{
    "target" : {
        "targetUID" : "62bcfb98f95174ad1900ea2535989b53",
        "targetType" : "database",
        "targetName" : "db1_target",
        "passwordpolicy" : "712375b4b7bb453c9482d02535989b53",
        "passwordrollover" : "true",
        "host" : "afg1140282",
        "domain" : "adc1140282Domain",
        "description" : "Dbase target for the automation",
        "connectionProperties" : "",
        "dbType" : "Oracle",
        "jdbcUrl" : "jdbc:oracle:thin:@afg1140282.us.pk.com:11227:db5474",
        "loginPassword" : "password1",
        "loginUser" : "system"
    }
}

例B-28 ターゲットのサンプルJSON表現(unixターゲット・タイプ)

{
    "target" : {
        "targetUID" : "62bcfb98f95174ad1900ea2535989b53",
        "targetType" : "unix",
        "targetName" : "unix1-target",
        "passwordpolicy" : "712375b4b7bb453c9482d02535989b53",
        "passwordrollover" : "true",
        "host" : "myhost.us.example.com",
        "domain" : "US",
        "description" : "Backup system",
        "organization" : "IT",
        "port" : "23",
        "sudoPasswdExpectExpression" : "password",
        "commandTimeout" : "120000",
        "passwordExpectExpressions" :
        "new[\\s](unix[\\s])?password:,new[\\s](unix[\\s])?password([\\s]again)?:",
        "loginShellPrompt" : "$",
        "prePasswdExpectExpression" : "None",
        "sudoAuthorization" : "false",
        "loginUserpassword" : "password1",
        "loginUser" : "aime2"
    }
}

例B-29 ターゲットのサンプルJSON表現(windowsターゲット・タイプ)

{
  "target":{
    "targetType":"windows",
    "targetName":"Windows7Target",
    "targetAgentKey" : "wsiaWCKz\/um9kJWTrjz8DaoM5mxnk\/sUIjDyEZrSc4FBHxO8P+3VS39xL8gQs3JuYlS6h+m01N\/5Rg0Y686xCorU=:AQAB"
    "targetUID" : "62bcfb98f95174ad1900ea2535989b53"
    "connectorserverid":"52d42cf53465939dce61d05",
    "passwordpolicy":"9a565659352d42cf53",
    "passwordrollover":"false",
    "host":"myhost.us.example.com",
    "domain":"US",
    "description":"Windows7 target system",
    "organization" : "IT",
    "AdminPassword":"Password1",
    "AdminName":"SLC05TYZ\Administrator"
  }
}

注意:

"targetAgentKey"パラメータはエージェント登録済ターゲットに対して表示されます。通常のWindowsターゲットに対しては表示されません。

説明:

targetは、ターゲットJSONオブジェクトです。
targetUIDは、ターゲットの一意識別子です。
targetNameは、ターゲットの名前です。
targetTypeは、ターゲット・タイプです。
passwordrolloverは、ターゲットのサービス・アカウント用の自動パスワード・リサイクルを有効にするかどうかを示すフラグです。

このフラグをtrueに設定すると、Oracle Privileged Account Managerによって、適用されているパスワード・ポリシーで指定されている設定に基づいてターゲットのサービス・アカウント・パスワードが自動的にリセットされます。

注意:
passwordrolloverフラグは、ldapとlockboxのどちらのターゲットに対しても現在サポートされていません。
connectorserveridは、ターゲットに関連付けられているコネクタ・サーバーを示します。ローカル・バンドルjarを使用しているターゲットの場合、connectorserveridは空になり、("")と表示されます。

他のすべての属性は、動的であり、第B.6.1項「ターゲット属性の取得」の属性に対応します。

B.6.5 ターゲットの更新

このAPIを使用してターゲットを更新します。

注意:

このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/target/{targetUID}
メソッド: PUT
Content-Type: application/json
本体: ターゲット変更のJSON表現
成功時の戻り値: ステータス・コード200

targetTypeおよびtargetUIDを除くすべての属性の変更が可能で、同時に複数の属性を変更できます。

例B-30 ターゲット変更のサンプルJSONオブジェクト

      {
         "modification":{
            "host":"opam_server_host"
         }
      },
      {
         "modification":{
            "port":"6000"
         }
      }
   ]
}

説明:

targetUIDは、ターゲットの一意識別子です。
modificationsは、変更JSONオブジェクトの配列です。
modificationは、単一属性の変更を表すJSONオブジェクトです。

B.6.6 ターゲットの削除

このAPIを使用してターゲットを削除します。

注意:

このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/target/{targetUID}
メソッド: DELETE
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200

B.6.7 ターゲットの検索

このAPIでは、次のリクエスト・パラメータのいずれかを使用してターゲットを検索します。

type
name
hostname
domain
description
org
customattrname
customattrvalue

これらのパラメータはすべてオプションです。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロール、セキュリティ管理者管理ロールまたは「セキュリティ監査者」管理ロールを持つ管理者である必要があります。
customattrnameごとに1つのcustomattrvalueが存在する必要があります。

例:

https://opam_server_host:opam_ssl_port/opam/target/search?customattrname=location&customattrvalue=US&customattrname=owner&customattrvalue=john

前述の例は、場所がUS、所有者がjohnのカスタム属性ペアを持つすべてのターゲットを検索します。

URI: https://opam_server_host:opam_ssl_port/opam/target/search?param1=value1&param2=value2
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびターゲット収集のJSON表現

サンプルURI:

https://opam_server_host:opam_ssl_port/opam/target/search?: すべてのターゲットが返されます。

https://opam_server_host:opam_ssl_port/opam/target/search?type=ldap&org=us: typeにldap、orgにusが含まれるすべてのターゲットが返されます。

例B-31 ターゲット収集のサンプルJSON表現

{
   "Target Collection":[
      {
         "target":{
            "uri":"https:\/\/opam_server_host:opam_ssl_port\/opam\/target\
               /9bbcbbb087174ad1900ea691a2573b61",
            "type":"ldap",
            "name":"person1-ldap",
            "host":"opam_server_host",
            "domain":"berkeley"
            "description" : "Ldap target"
         }
      },
      {
         "target":{
            "uri":"https:\/\/opam_server_host:opam_ssl_port\/opam\/target\
               /ac246a162ce948c7b1cdcc17dfc92c15",
            "type":"ldap",
            "name":"person1-ldap2",
            "host":"opam_server_host:opam_ssl_port",
            "domain":"berkeley"
            "description" : "Ldap target"
         }
      }
   ]
}

説明:

Target Collectionは、ターゲットJSONオブジェクトの配列です。
targetは、ターゲットJSONオブジェクトです。
uriは、ターゲット・リソースのURIです。
typeは、ターゲット・タイプです。
hostnameは、ターゲットのホスト名です。
nameは、ターゲット名です。
orgは、ターゲットの組織です。
domainは、ターゲットのドメインです。
descriptionは、ターゲット・システムの説明です。

B.6.8 使用可能なアカウントの取得

このAPIを使用して、ターゲット・システムに存在するすべてのアカウントを取得します。

注意:

このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/target/{targetUID}/availableaccounts
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200 (OK)およびアカウント収集のJSON表現

例B-32 アカウント収集のサンプルJSON表現

{
   "AvailableAccounts":[
      {
         "accountName":"SCOTT",
         "accountUid":"SCOTT"
      },
      {
         "accountName":"BLAKE",
         "accountUid":"BLAKE "
      },
      {
         "accountName":"JONES",
         "accountUid":"JONES"
      }
   ]
}

説明:

AvailableAccountsは、ターゲット・システムに存在するアカウントの配列です。
accountNameは、アカウント名です。
accountUIDは、アカウントの一意識別子です。

B.6.9 ターゲットで登録されているアカウントの取得

このAPIを使用して、ターゲットでOracle Privileged Account Managerに登録されているすべてのアカウントを取得します。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロール、セキュリティ管理者管理ロールまたは「セキュリティ監査者」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/target/{targetUID}/accounts
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびアカウント・サーバーのURI収集のJSON表現

例B-33 アカウントのURI収集のサンプルJSON表現

{
   "URI Collection":[
      {
         "account":{
            "uri":"https:\/\/opam_server_host:opam_ssl_port\/opam\/account\
               /3740553e999a4f6aa8e8f9286d320cb4",
            "accountName":"sherlock"
         }
      },
      {
         "account":{
            "uri":"https:\/\/opam_server_host:opam_ssl_port\/opam\/account\
               /c11066278022489aad758aec69d9727d",
            "accountName":"root"
         }
      }
   ]
}

説明:

URI Collectionは、ターゲットでOracle Privileged Account Managerに登録されているアカウントの配列です。
accountは、アカウントJSONオブジェクトです。
uriは、アカウントのURIです。
accountNameは、アカウント名です。

B.6.10 ターゲット・タイプの取得

このAPIを使用して、サポートされるすべてのターゲット・タイプのリストを取得します。

URI: https://opam_server_host:opam_ssl_port/opam/target/types
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびサポートされるターゲット・タイプのJSON表現

例B-34 サポートされるターゲット・タイプのサンプルJSON表現

{
   "targettypes":[
      "ldap",
      "unix",
      "database",
      "lockbox"
      "sapum"
      "sapume"
      "unix"
      "windows"
   ]
}

ここで、targettypesは、サポートされるターゲット・タイプです。

B.6.11 パスワードのリセット

このAPIを使用して、ターゲットのサービス・アカウントのパスワードをリセットします。

注意:

このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。
サービス・アカウントの詳細は、第7章「サービス・アカウントの使用」を参照してください。

URI: https://opam_server_host:opam_ssl_port/opam/target/{targetUID}/resetpassword
メソッド: PUT
Content-Type: application/json
本体: NA
成功時の戻り値: ステータス・コード200

例B-35 新規パスワードのサンプルJSON表現

{
   "password":"password1"
}

または

{
   "autogen":"true"
}

説明:

targetUIDは、ターゲットの一意識別子です。
passwordは、サービス・アカウントに割り当てるパスワードです。
autogenは、パスワードを自動的に生成するかどうかを制御するフラグです。このフラグのデフォルト値はfalseです。

B.6.12 サービス・アカウント・パスワードの表示

このAPIを使用して、サービス・アカウント・パスワードを取得して表示します。

注意:

このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。
サービス・アカウントの詳細は、第7章「サービス・アカウントの使用」を参照してください。

URI: https://opam_server_host:opam_ssl_port/opam/target/{targetUID}/showpassword
メソッド: GET
Content-Type: application/json
本体: NA
成功時の戻り値: ステータス・コード200およびサービス・アカウントのJSON表現

例B-36 アカウント・トークンのサンプルJSON表現

{
  "serviceAccount" : {
    "targetName" : "APILDAP",
    "targetUID" : "62bcfb98f95174ad1900ea2535989b53",
    "targetAccount" : "cn=admin",
    "targetPassword" : "password1",
    "targetPasswordChangeTime" : " 2013-01-27 02:58:13.259"
  }
}

説明:

targetUIDは、ターゲットの一意識別子です。
targetNameは、ターゲットの名前です。
targetAccountは、ターゲットのサービス・アカウントです。
targetPasswordは、サービス・アカウント・パスワードです。
targetPasswordChangeTimeは、パスワードが変更された時間です。

B.6.13 サービス・アカウント・パスワードの表示(非推奨)

注意:

このAPIは非推奨となりました。第B.6.12項「サービス・アカウント・パスワードの表示」のサービス・アカウント・パスワードの表示APIを使用することをお薦めします。

このAPIを使用して、サービス・アカウント・パスワードを取得して表示します。

注意:

このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。
サービス・アカウントの詳細は、第7章「サービス・アカウントの使用」を参照してください。

URI: https://opam_server_host:opam_ssl_port/opam/target/{targetUID}/showpassword
メソッド: PUT
Content-Type: application/json
本体: NA
成功時の戻り値: ステータス・コード200およびサービス・アカウントのJSON表現

例B-37 アカウント・トークンのサンプルJSON表現

{
  "serviceAccount" : {
    "targetName" : "APILDAP",
    "targetUID" : "62bcfb98f95174ad1900ea2535989b53",
    "targetAccount" : "cn=admin",
    "targetPassword" : "password1",
    "targetPasswordChangeTime" : " 2013-01-27 02:58:13.259"
  }
}

説明:

targetUIDは、ターゲットの一意識別子です。
targetNameは、ターゲットの名前です。
targetAccountは、ターゲットのサービス・アカウントです。
targetPasswordは、サービス・アカウント・パスワードです。
targetPasswordChangeTimeは、パスワードが変更された時間です。

B.6.14 サービス・アカウント・パスワード履歴の表示

このAPIを使用して、サービス・アカウント・パスワード履歴を取得および表示します。

注意:

このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。
サービス・アカウントの詳細は、第7章「サービス・アカウントの使用」を参照してください。

URI: https://opam_server_host:opam_ssl_port/opam/target/{targetUID}/showpasswordhistory
メソッド: GET
Content-Type: application/json
本体: NA
成功時の戻り値: ステータス・コード200およびサービス・アカウント・サーバーのJSON表現

例B-38 ターゲット・トークンのサンプルJSON表現

{
    "targetToken": {
        "targetName": "SessionMgr_Target",
        "targetUID": "62bcfb98f95174ad1900ea2535989b53",
        "passwordHistory": [
            {
                "targetPassword": "password1",
                "modificationTime": "1383078344"
            },
            {
                "targetPassword": "4PkVerh7",
                "modificationTime": "1383078329"
            },
            {
                "targetPassword": "l9yAigqj",
                "modificationTime": "1383078314"
            },
            {
                "targetPassword": "password1",
                "modificationTime": "1383010874"
            }
        ]
    }
}

説明:

targetUIDは、ターゲットの一意識別子です。
targetNameは、ターゲットの名前です。
passwordHistoryは、サービス・アカウント・パスワード履歴です。
targetPasswordは、サービス・アカウント・パスワードです。
modificationTime (秒単位のUTC時刻)は、パスワードが変更されたときの時刻です。

パスワード履歴結果は、最新の結果が最上位になるように変更時刻でソートされます。

B.7 アカウント・リソース

この項では次のAPIについて説明します。

第B.7.1項「ターゲットへのアカウントの追加」
第B.7.2項「アカウントの適用可能な使用ポリシーの取得」
第B.7.3項「アカウントに対するアクセス権のユーザーまたはロールへの付与」
第B.7.4項「アカウントのCSFマップとキーの追加または削除」
第B.7.5項「アカウントの検索」
第B.7.6項「割当て済アカウントの検索」
第B.7.7項「アカウントの取得」
第B.7.8項「アカウントの権限受領者の取得」
第B.7.9項「アカウントをチェックアウトしたユーザーの取得」
第B.7.10項「アカウントのチェックアウト」
第B.7.11項「すべてのチェックアウト済アカウントの取得」
第B.7.12項「セッション・チェックアウトの方法の取得」
第B.7.13項「アカウントのチェックアウト履歴」
第B.7.14項「チェックアウト履歴」
第B.7.15項「アカウントのチェックイン」
第B.7.16項「アカウントの検証」
第B.7.17項「アカウントの更新」
第B.7.18項「アカウントの削除」
第B.7.19項「アカウントに対するユーザーまたはロールのアクセス権の削除」
第B.7.20項「パスワードの表示」
第B.7.21項「パスワードの表示(非推奨)」
第B.7.22項「パスワード履歴の表示」
第B.7.23項「パスワード履歴の表示(非推奨)」
第B.7.24項「パスワードのリセット」

B.7.1 ターゲットへのアカウントの追加

このAPIを使用してターゲットにアカウントを追加します。このAPIは、ターゲット・システムにアカウントを作成しませんが、既存のアカウントをOracle Privileged Account Managerターゲットに登録します。

注意:

Oracle Privileged Account Managerで管理されるサービス・アカウントや特権アカウントと同じアカウントはけっして使用しないでください。
このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/accoun
メソッド: POST
Content-Type: application/json
本体: アカウントの追加または検証のJSON表現
成功時の戻り値: ステータス・コード201および場所

例B-39 アカウントの追加または検証のサンプルJSON表現

{
   "account":{
      "accountName":"admin",
      "description" : "maintenance account on the machine",
      "password" : "password1",
      "passwordpolicy":"passwordpolicy2",
      "shared":"true",
      "targetUID":"62bcfb98f95174ad1900ea2535989b53"
      "accountCustomAttrs": [{"accountCustomAttr": {
        "attrname": "attr1",
        "attrvalue": ["100"]
          }}]
 
   }
}

説明:

accountは、アカウントJSONオブジェクトです。
accountNameは、アカウントの名前です。
descriptionは、アカウントの説明です。この属性はオプションlです。
passwordは、アカウント・パスワードです。この属性はオプションlです。
passwordpolicyは、アカウントに適用可能なパスワード・ポリシーのポリシーIDです。このパラメータはオプションです。デフォルトでは、このパラメータはグローバル・デフォルト・パスワード・ポリシーを使用します。
sharedは、アカウントの共有ステータスを示します。この値はブール値であり、デフォルト設定はfalseです。
targetUIDは、ターゲットの一意識別子です。

B.7.2 アカウントの適用可能な使用ポリシーの取得

このAPIを使用して、アカウントの適用可能な使用ポリシーを取得します。

URI: https://opam_server_host:opam_ssl_port/opam/account/
accountUID/usagepolicy
メソッド: GET
Content-Type: NA
成功時の戻り値: ステータス・コード200および使用ポリシーのJSON表現

例B-40 使用ポリシーのサンプルJSON表現

{"usagepolicy":
    {
        "policyid":"bafd53072bbb442db185dca18bd00e69",
        "policyname":"usage_policy_anytime"
    }
}

説明:

usagepolicyは、使用ポリシーJSONオブジェクトです。
policyidは、使用ポリシーの一意識別子です。
policynameは、ポリシーの名前です。

B.7.3 アカウントに対するアクセス権のユーザーまたはロールへの付与

このAPIを使用して、アカウントに対するアクセス権をユーザーまたはロールに付与します。複数のユーザーおよびロールに同時にアクセス権を付与できます。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/account/{accountUID}
メソッド: PUT
Content-Type: application/json
本体: 権限受領者の追加のJSON表現
成功時の戻り値: ステータス・コード200

例B-41 権限受領者の追加のサンプルJSON表現

{
   "modifications":[
      {
         "modification":{
            "usagepolicy":"712375b4b7bb453c9482d02535989b53",
            "role":"opamgroup1",
            "operation":"add"
         }
      },
      {
         "modification":{
            "usagepolicy":"usagepolicy1",
            "user":"opamuser1",
            "operation":"add"
         }
      }
   ]
}

説明:

accountUIDは、アカウントの一意識別子です。
modificationsは、変更JSONオブジェクトの配列です。
modificationは、単一属性の変更を表すJSONオブジェクトです。
roleは、グループにアクセス権を付与する必要があることを示します。このパラメータの値は、グループ名です。
userは、ユーザーにアクセス権を付与する必要があることを示します。このパラメータの値は、ユーザー・ログインIDです。
usagepolicyは、権限付与に適用される使用ポリシーの識別子を示します。
operationは、実行される操作のタイプを示します。有効な値は次のとおりです。
- addは権限付与を示します。
- deleteは取消しを示します。
- replaceは使用ポリシーの新しい値による置換を示します。

B.7.4 アカウントのCSFマップとキーの追加または削除

このAPIを使用して、CSFマップとキーをアカウントに追加したり、アカウントから削除します。複数のマップとキーを同時に追加または削除できます。

注意:

このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https:///opam_server_host:opam_ssl_port/opam/account/{accountUID}
メソッド: PUT
Content-Type: application/json
本体: キーマップの追加のJSON表現
成功時の戻り値: ステータス・コード200

例B-42 マップとキーの追加/削除のサンプルJSON表現

{
    "modifications": [
        {
            "modification": {
                "keymap": "[app1][sd45kjlf4g][t3://myhost:2001][weblogic][password]",
                "operation": "add"
            }
        },
        {
            "modification": {
                "keymap": "[hrmap][hrkey2][t3://myhost:2001][weblogic][password]",
                "operation": "delete"
            }
        }
    ]
}

説明:

accountUIDは、アカウントの一意識別子です。
modificationsは、変更JSONオブジェクトの配列です。
modificationは、単一属性の変更を表すJSONオブジェクトです。
keymapは、追加または削除するマップとキーです。マップとキーは、次の形式にする必要があります。
```
[csfmap][csfkey][Administration Server Url][username][password]
```
operationは、実行される操作のタイプを示します。有効な値は次のとおりです。
- addは、マップとキーの追加を示します。
- deleteは、マップとキーの削除を示します。

B.7.5 アカウントの検索

このAPIでは、次の検索リクエスト・パラメータを1つ以上使用してアカウントを検索します。

type
domain
description
name
accountname
customattrname
customattrvalue

これらのパラメータはすべてオプションです。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロール、「セキュリティ監査者」管理ロールまたは「セキュリティ管理者」管理ロールを持つ管理者である必要があります。
customattrnameごとに1つのcustomattrvalueが存在する必要があります。

例:

https://opam_server_host:opam_ssl_port/opam/account/search?customattrname=location&customattrvalue=US&customattrname=owner&customattrvalue=john

前述の例は、場所がUS、所有者がjohnのカスタム属性ペアを持つすべてのターゲットを検索します。

URI: https://opam_server_host:opam_ssl_port/opam/account/search?
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびアカウント収集のJSON表現

例B-43 アカウント収集のサンプルJSON表現

{
    "AccountCollection" : [
        {
            "account" : {
            "shared" : false,
            "passwordchangetime" : 1383072107,
            "targetUID" : "62bcfb98f95174ad1900ea2535989b53",
            "domain" : "needtofix",
            "targetName" : "sunds_6.3_target",
            "targetType" : "ldap",
            "accountlevelstatus" : "checkedIn",
            "description" : "",
            "accountName" : "dsperson1",
            "uri" : "https://localhost:7002/opam/account/35e2709edf0443edae8f67727d937bec",
            "accountUID" : "35e2709edf0443edae8f67727d937bec"
        }
            },
        {
            "account" : {
            "shared" : false,
            "passwordchangetime" : 1383072107,
            "targetUID" : "62bcfb98f95174ad1900ea2535989b53",
            "domain" : "needtofix",
            "targetName" : "sunds_6.3_target",
            "targetType" : "ldap",
            "accountlevelstatus" : "checkedIn",
            "description" : "",
            "accountName" : "dsperson10",
            "uri" : "https://localhost:7002/opam/account/0a1ee2cb17e345cdb537a2f05e11e93c",
            "accountUID" : "0a1ee2cb17e345cdb537a2f05e11e93c"
            }
        }
 
    ],
  "count" : 2
}

説明:

accountは、アカウントJSONオブジェクトです。
sharedは、アカウントの共有ステータスを示します。この値はブール値であり、デフォルト設定はfalseです。
accountlevelstatusは、アカウントがユーザーによってチェックインされたかどうかを示します。有効な値は、checkedInおよびcheckedOutです。
descriptionは、アカウントの説明です。この属性はオプションlです。
accountNameは、アカウントの名前です。
accountUIDは、アカウントの一意識別子です。
passwordchangetimeは、パスワードが変更された時間です。

他のすべての属性定義は、第B.6項「ターゲット・リソース」を参照してください。

B.7.6 割当て済アカウントの検索

このAPIを使用して割当て済アカウントを検索します。その際は、次の検索リクエスト・パラメータを1つ以上使用します。

type
domain
description
name
accountname

これらのパラメータはすべてオプションです。

URI: https://opam_server_host:opam_ssl_port/opam/account/myaccounts/search?
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびアカウント収集のJSON表現

例B-44 アカウント収集のサンプルJSON表現

{
  "AccountCollection": [
    {
      "account": {      
        "uri": "https://myhost:7002/opam/account/aa243a9323974eca84d4141193ca58e1",
        "accountUID": "aa243a9323974eca84d4141193ca58e1",
        "accountName": "account1",
        "description": ""8759",
        "targetUID": "62bcfb98f95174ad1900ea2535989b53",
        "targetName":   "kiki",
        "targetType": "lockbox",
        "domain": ""
        "host": "kiki"
      }
    }
  ],
{
  "AccountCollection": [
    {
      "account": {      
        "uri": "https://myhost:7002/opam/account/086931f6816647f0a4c0ca6b28055739",
        "accountUID": "086931f6816647f0a4c0ca6b28055739",
        "accountName": "hello",
        "description": "8759",
        "targetUID": "62bcfb98f95174ad1900ea2535989b53",
        "targetName": "lockbox2",
        "targetType": "lockbox",
        "domain": ""
        "host": "myhost.us.example.com"
      }
    }
  ],
    "count": 2
}

説明:

accountは、アカウントJSONオブジェクトです。
accountUIDは、アカウントの一意識別子です。
accountNameは、アカウントの名前です。
descriptionは、アカウントの説明です。この属性はオプションlです。

他のすべての属性定義は、第B.6項「ターゲット・リソース」を参照してください。

B.7.7 アカウントの取得

このAPIを使用してアカウントを取得します。

URI: https://opam_server_host:opam_ssl_port/opam/account/{accountUID}
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびアカウント・サーバーのJSON表現

例B-45 アカウントのサンプルJSON表現

{
   "account":{
      "accountUID":"aa243a9323974eca84d4141193ca58e1",
      "description":"8759",
      "targetUID":"62bcfb98f95174ad1900ea2535989b53",
      "accountName":"account1",
      "shared":false,
      "keymaps":[],
      "passwordpolicy":"passwordpolicy1",
      "accountlevelstatus":"checkedIn",
      "passwordchangetime":"1421107647",
   }
}

説明:

accountは、アカウントJSONオブジェクトです。
accountUIDは、アカウントの一意識別子です。
accountNameは、アカウントの名前です。
passwordpolicyは、アカウントに適用可能なパスワード・ポリシーのポリシーIDです。
sharedは、アカウントの共有ステータスを示します。この値はブール値であり、デフォルト設定はfalseです。
targetUIDは、ターゲットの一意識別子です。
accountlevelstatusは、アカウントがユーザーによってチェックインされたかどうかを示します。有効な値は、checkedInおよびcheckedOutです。
protocolは、Oracle Privileged Session Managerサーバーへの接続に使用されるプロトコルです。
portは、Oracle Privileged Session Managerサーバーへの接続に使用されるポートです。

B.7.8 アカウントの権限受領者の取得

このAPIを使用して、アカウントのすべての権限受領者を取得します。権限受領者は、ユーザーまたはロールです。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロールまたはセキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/account/{accountUID}/grantees
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200および権限受領者のJSON表現

例B-46 権限受領者のサンプルJSON表現

{
   "grantees":{
      "users":[
         "opamuser1"
      ],
      "roles":[
         "opamgroup1"
      ]
   }
}

説明:

granteesは、アカウントの権限受領者です。
usersは、アカウントを付与されたユーザーです。各値は、ユーザーのログインID/UIDです。
rolesは、アカウントを付与されたグループまたはロールです。各値はグループ名です。

B.7.9 アカウントをチェックアウトしたユーザーの取得

このAPIを使用して、現在アカウントをチェックアウトしているすべてのユーザーのリストを取得します。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロール、「セキュリティ監査者」管理ロールまたは「セキュリティ管理者」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/account/{accountUID}/whocheckedout
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびアカウントをチェックアウトしたユーザーのJSON表現

例B-47 アカウントをチェックアウトしたユーザーのサンプルJSON表現

{
  "users": [   
    {
        "user": {
        "uid": "user_manager",
        "expiryTime": "1382147587",
        "checkoutTime": "1381715587",
        "checkoutUID": "f499b76719ba4d0aa30487e58316def3",
        "checkoutType": "password",
        "transcriptURL": ""
  }
    },
      {
        "user": {
        "uid": "user_manager",
        "expiryTime": "1382147587",
        "checkoutTime": "1381715587",
        "checkoutUID": "f499b76719ba4d0aa30487e58316def3",
        "checkoutType": "session",
        "transcriptURL": "https://myhost:2001/opam/checkout/dee8383184664ddfa09f454d0a9a023d/
          transcript"
      }
    }
  ]
}

説明:

transcriptURLは、セッション・トランスクリプトへのアクセスに使用するURLです。
checkoutTypeは、チェックアウトがセッション・チェックアウトであったか、パスワード・チェックアウトであったかを示します。
checkoutUIDは、チェックアウトの一意のIDです。

B.7.10 アカウントのチェックアウト

このAPIを使用してアカウントをチェックアウトします。

URI: https://opam_server_host:opam_ssl_port/opam/account/v1/{accountUID}/checkout
メソッド: PUT
Content-Type: application/json
本体: NA
成功時の戻り値: ステータス・コード200およびアカウント・トークンのJSON表現

例B-48 アカウント・トークンのサンプルJSON表現

{
   "accountToken":{
      "accountName":"admin",
      "accountUID":"3f74a85e39e64432ba917a2e60fa15aa",
      "accountPassword":"GJN8p2ol"
   }
}

説明:

accountUIDは、アカウントの一意識別子です。
accountNameは、アカウントの名前です。

accountpasswordは、アカウント・パスワードです。

注意:

バージョンv1では、リピート・チェックアウトにおいて、アカウントがすでにチェックアウト済であるというメッセージとともにアカウント・トークンが返されます。以前のバージョンでは、エラー・メッセージのみが送信されました。この動作は(https://opam_server_host:opam_ssl_port/opam/account/{accountUID}/checkout)で保持されます。

B.7.11 すべてのチェックアウト済アカウントの取得

このAPIを使用して、ログイン・ユーザーによってチェックアウトされたすべてのアカウントのリストを取得します。

URI: https://opam_server_host:opam_ssl_port/opam/account/mycheckouts
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびアカウント収集のJSON表現

例B-49 アカウント収集のサンプルJSON表現

{
  "Checkouts": [
    {
      "uri": "https://myhost:7002/opam/account/b0e7ae053afb45658da4e3a0453bffec",
      "accountUID": "b0e7ae053afb45658da4e3a0453bffec",
      "accountName": "dduck",
      "status": "checkedOut",
      "targetUID": "62bcfb98f95174ad1900ea2535989b53",
      "targetName": "unix1-target",
      "targetType": "unix",
      "domain": "US",
      "expiryTime": "1371945854",
      "checkoutUID": "b97b2de6a80b40c48f873067027ac476",
      "checkoutType": "session",
      "transcriptURL": "https://myhost:2001/opam/account/checkout/b97b2de6a80b40c48f873067027ac476/
           transcript"
    },
    {
      "uri": "https://myhost:7002/opam/account/b0e7ae053afb45658da4e3a0453bffec",
      "accountUID": "b0e7ae053afb45658da4e3a0453bffec",
      "accountName": "dduck",
      "status": "checkedOut",
      "targetUID": "62bcfb98f95174ad1900ea2535989b53",
      "targetName": "unix1-target",
      "targetType": "unix",
      "domain": "US",
      "expiryTime": "1371940624",
      "checkoutUID": "bf43672ffd3a43018cdfde9b78bf1691",
      "checkoutType": "password",
      "transcriptURL": ""
    }
  ]
}

説明:

accountUIDは、アカウントの一意識別子です。
accountNameは、アカウントの名前です。
checkoutUIDは、チェックアウトの一意のIDです。
checkoutTypeは、チェックアウトがセッション・チェックアウトであったか、パスワード・チェックアウトであったかを示します。
transcriptURLは、セッション・トランスクリプトにアクセスするためのURLです。

他のすべての属性定義は、第B.6項「ターゲット・リソース」を参照してください。

B.7.12 セッション・チェックアウトの方法の取得

このAPIを使用して、セッション・チェックアウトの実行に役立つ情報を取得します。

注意:

パスワードおよびセッションのチェックアウトの詳細は、第9.5項「特権アカウントのチェックアウト」および第9.5.3項「特権アカウント・セッションのチェックアウト」を参照してください。

URI: https://opam_server_host:opam_ssl_port/opam/account/{accountUID}/checkout/
session/instructions
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200および出力のJSON表現

例B-50 セッション・チェックアウトの方法のサンプルJSON表現

{
  "sessionCheckoutInstructions": {
    "accountName": "dduck",
    "targetName": "bkottaha-unix",
    "port": 1222,
    "instruction": "ssh -p <port> <opamuser>:<targetname>:<accountname>@
       <sessionmgrhost>\n Use opam password on password prompt"
  }
}

説明:

accountNameは、アカウントの名前です。
targetNameは、ターゲットの名前です。
portは、セッション・マネージャが接続をリスニングするために使用するポートです。
instructionは、セッション・チェックアウトの実行に必要な情報です。

B.7.13 アカウントのチェックアウト履歴

このAPIを使用して、次のパラメータの1つ以上を使用してアカウントのチェックアウト履歴を検索します。

from: 開始時刻を秒単位(UTC)で指定します(必須)。
to: 終了時刻を秒単位(UTC)で指定します(必須)。
uid: ユーザーIDを指定します(オプション)。
pattern: 実行されたコマンドまたはログ内の用語を指定します(オプション)。
size: 返される配列要素の数を指定します(オプション)。

fromおよびtoパラメータを使用して、チェックアウトが実行された期間を指定します。

注意:

この問合せにアクセスするには、「ユーザー・マネージャ」またはセキュリティ管理者の管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/account/{accountUID}/checkouts/
historical/search?param1=val1
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200および出力のJSON表現

サンプルURL出力

https://myhost:7002/opam/account/8d9e9ce750da4aedac3ffbea0d28a73a/checkouts/historical/search?from=123&to=1372893007&size=2&pattern=ls

例B-51 アカウント・チェックアウト履歴のサンプルJSON表現

{
   "checkouts":[
      {
         "checkout":{
            "accountName":"itsupport",
            "targetName":"unixTarget",
            "uid":"end_user",
            "starttime":"1404691650",
            "endtime":"1404691654",
            "recordingType":"text\/plain",
            "transcriptURL":"https:\/\/myhost:2001\/opam\/checkout\/c3bcb3366581420d9d8166810c1c72da\/transcript",
            "transcript":"\/checkout\/c3bcb3366581420d9d8166810c1c72da\/transcript"
         }
      },
      {
         "checkout":{
            "accountName":"itsupport",
            "targetName":"unixTarget",
            "uid":"end_user",
            "starttime":"1404691378",
            "endtime":"1404691387",
            "recordingType":"text\/html",
            "transcriptURL":"https:\/\/myhost:2001\/opam\/checkout\/b869b1d8a48a4b459adaff010c887543\/transcript",
            "metadata":"\/checkout\/b869b1d8a48a4b459adaff010c887543\/metadata",
            "transcript":"\/checkout\/b869b1d8a48a4b459adaff010c887543\/transcript"
         }
      }
   ],
   "totalcount":5,
   "returncount":5
}

説明:

transcriptURLは、セッション・トランスクリプトへのアクセスに使用するURLです。
checkoutTypeは、チェックアウトがセッション・チェックアウトであったか、パスワード・チェックアウトであったかを示します。
checkoutUIDは、チェックアウトの一意のIDです。
totalcountは、実際の検索結果の数です。
returncountは、実際に返された検索結果の数です。これはサイズによって決まります。
recordingTypeは、プレーン・テキスト形式("text/plain")または対話型形式("text/html")で使用できます。
metadataは、セッションのxmlメタデータに対応するOPAMのベースURLへの相対リンクです。

注意:
メタデータが存在しない場合、メタデータ属性はありません。
videoは、ビデオへの相対リンクです。
transcriptは、トランスクリプトの相対リンクです。このトランスクリプトは、プレーン・テキスト形式またはhtml形式です。

他のすべての属性定義は、第B.7項「アカウント・リソース」を参照してください。

B.7.14 チェックアウト履歴

このAPIを使用して、次のパラメータの1つ以上を使用してすべてのアカウントのチェックアウト履歴を検索します。

from: 開始時刻を秒単位(UTC)で指定します(必須)。
to: 終了時刻を秒単位(UTC)で指定します(必須)。
targetname: 検索対象のターゲットの名前を指定します(オプション)。
accountname: 検索するアカウントの名前を指定します(オプション)。
uid: ユーザーIDを指定します(オプション)。
pattern: 実行されたコマンドまたはログ内の用語を指定します(オプション)。
size: 返される配列要素の数を指定します(オプション)。

fromおよびtoパラメータを使用して、チェックアウトが実行された期間を指定します。

注意:

この問合せにアクセスするには、「セキュリティ監査者」の管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/checkout/historical/search?param1=val1
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200および出力のJSON表現

サンプルURL

https://myhost:7002/opam/checkout/historical/search?from=123&to=
1472816146&size=2&pattern=ls&accountname=a&targetname=h&uid=u

例B-52 チェックアウト履歴のサンプルJSON表現

{
   "checkouts":[
      {
         "checkout":{
            "accountName":"itsupport",
            "targetName":"unixTarget",
            "uid":"end_user",
            "starttime":"1404691650",
            "endtime":"1404691654",
            "recordingType":"text\/plain", 

            "transcriptURL":"https:\/\/myhost:2001\/opam\/checkout\/b869b1d8a48a4b459adaff010c887543\/transcript",

           "transcript":"\/checkout\/c3bcb3366581420d9d8166810c1c72da\/transcript 
         }
      },
      {
         "checkout":{
            "accountName":"itsupport",
            "targetName":"unixTarget",
            "uid":"end_user",
            "starttime":"1404691378",
            "endtime":"1404691387",
            "recordingType":"text\/html",

            "transcriptURL":"https:\/\/myhost:2001\/opam\/checkout\/b869b1d8a48a4b459adaff010c887543\/transcript",

            "metadata":"\/checkout\/b869b1d8a48a4b459adaff010c887543\/metadata",
           "transcript":"\/checkout\/b869b1d8a48a4b459adaff010c887543\/transcript"
         }
      },
      {
         "checkout":{
            "accountName":"SystemAdmin",
            "targetName":"WinTarget",
            "uid":"end_user",
            "starttime":"1403501578",
            "endtime":"1403501593",
            "recordingType":"video",
            "video":"\/checkout\/bde06872949740a59dc5a702d8aca48e\/video",
            "metadata":"\/checkout\/bde06872949740a59dc5a702d8aca48e\/metadata"
         }
      }
 
   ],
   "totalcount":5,
   "returncount":5
}

説明:

transcriptURLは、セッション・トランスクリプトへのアクセスに使用するURLです。
checkoutTypeは、チェックアウトがセッション・チェックアウトであったか、パスワード・チェックアウトであったかを示します。
checkoutUIDは、チェックアウトの一意のIDです。
totalcountは、実際の検索結果の数です。
returncountは、実際に返された検索結果の数です。これはサイズによって決まります。
recordingTypeは、プレーン・テキスト形式("text/plain")または対話型形式("text/html")で使用できます。
metadataは、セッションのxmlメタデータに対応するOPAMのベースURLへの相対リンクです。

注意:
メタデータが存在しない場合、メタデータ属性はありません。
videoは、ビデオへの相対リンクです。
transcriptは、トランスクリプトの相対リンクです。このトランスクリプトは、プレーン・テキスト形式またはhtml形式です。

他のすべての属性定義は、第B.7項「アカウント・リソース」を参照してください。

B.7.15 アカウントのチェックイン

このAPIを使用してアカウントをチェックインします。

チェックアウトは、passwordチェックアウトの場合もsessionチェックアウトの場合もあります。checkoutUIDを使用して各チェックアウトを個別にチェックインすることも、1つのアカウントのすべてのチェックアウトをチェックインすることもできます。このマニュアルでは、「アカウントのチェックアウト」という用語は、通常、後者を指します。

注意:

強制的チェックインを実行するには、「ユーザー・マネージャ」管理ロールを持管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/account/{accountUID}/checkin
メソッド: PUT
Content-Type: application/json
本体: NA
成功時の戻り値: ステータス・コード200

アカウント・チェックインのサンプルJSON表現

次の例は、様々なタイプの強制的チェックインを示しています。

例B-53「パスワードまたはセッション・チェックアウトのセルフ・チェックイン」
例B-54「すべてのユーザーに対するアカウント(パスワードとセッションの両方)の強制的チェックイン」
例B-55「一人のユーザーに対するアカウント(パスワードとセッションの両方)の強制的チェックイン」
例B-56「パスワードまたはセッションの強制的チェックイン」

例B-53 パスワードまたはセッション・チェックアウトのセルフ・チェックイン

{
  "checkoutUID":"9c3c5d687d414a57b7dbda0692c9b06d"
}

例B-54 すべてのユーザーに対するアカウント(パスワードとセッションの両方)の強制的チェックイン

{
  "force":"true"
 
}

例B-55 一人のユーザーに対するアカウント(パスワードとセッションの両方)の強制的チェックイン

{
  "force" : "true",
  "userid" : "person1"
}

例B-56 パスワードまたはセッションの強制的チェックイン

{
  "force" : "true",
  "checkoutUID" : "9c3c5d687d414a57b7dbda0692c9b06d",
}

注意:

アカウントの(パスワードとセッションの両方に対する)チェックインを実行する場合、JSON本体にコンテンツを入力する必要はありません。

説明:

forceは、強制的チェックインを示すフラグです。このフラグのデフォルト値はfalseです。
useridは、強制的にチェックインされるユーザーです。デフォルト処理では、アカウントからチェックアウトしているすべてのユーザーに対して強制的チェックインが実行されます。
checkoutUIDは、チェックアウトの一意の識別子です。

B.7.16 アカウントの検証

このAPIを使用して、アカウントがターゲット・システムに存在するかどうかを検証します。

URI: https://opam_server_host:opam_ssl_port/opam/account/test
メソッド: PUT
Content-Type: application/json
本体: アカウントの追加または検証のJSON表現
成功時の戻り値: ステータス・コード200

例B-57 アカウントの追加または検証のサンプルJSON表現

{
   "account":{
      "accountName":"admin",
      "description" : "maintenance account on the machine"
      "password" : "password1"
      "passwordpolicy":"passwordpolicy2",
      "shared":"true",
      "targetUID":"62bcfb98f95174ad1900ea2535989b53"
   }
}

説明:

accountは、アカウントJSONオブジェクトです。
accountNameは、アカウントの名前です。
descriptionは、アカウントの説明です。この属性はオプションlです。
passwordは、アカウント・パスワードです。この属性はオプションlです。
passwordpolicyは、アカウントに適用可能なパスワード・ポリシーのポリシーIDです。このパラメータはオプションです。デフォルトでは、このパラメータはグローバル・デフォルト・パスワード・ポリシーを使用します。
sharedは、アカウントの共有ステータスを示します。この値はブール値であり、デフォルト設定はfalseです。
targetUIDは、ターゲットの一意識別子です。

B.7.17 アカウントの更新

このAPIを使用してアカウントを更新します。同時に複数の属性を変更できます。passwordpolicy、descriptionおよびshared属性のみ更新できます。

注意:

このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/account/{accountUID}
メソッド: PUT
Content-Type: application/json
本体: アカウント変更のJSON表現
成功時の戻り値: ステータス・コード200

例B-58 アカウント変更のサンプルJSON表現

{
   "modifications":[
      {
         "modification":{
            "passwordpolicy":"passwordpolicy2"
         }
      },
      {
         "modification":{
            "shared":"false"
         }
      }
   }
}

説明:

accountUIDは、アカウントの一意識別子です。
modificationsは、変更JSONオブジェクトの配列です。
modificationは、単一属性の変更を表すJSONオブジェクトです。

B.7.18 アカウントの削除

このAPIを使用してアカウントを削除します。

注意:

このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/account/{accountUID
メソッド: DELETE
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200

説明:

accountUIDは、アカウントの一意識別子です。

B.7.19 アカウントに対するユーザーまたはロールのアクセス権の削除

このAPIを使用して、アカウントに対するユーザーのアクセス権またはロールのアクセス権を削除します。複数のユーザーおよびロールの権限付与を同時に取り消すことができます。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/account/{accountUID}
メソッド: PUT
Content-Type: application/json
本体: 権限受領者の削除のJSON表現
成功時の戻り値: ステータス・コード200

例B-59 権限受領者の削除のサンプルJSON表現

{
   "modifications":[
      {
         "modification":{
            "usagepolicy":"usagepolicy1",
            "role":"opamgroup1",
            "operation":"delete"
         }
      },
      {
         "modification":{
            "usagepolicy":"usagepolicy1",
            "user":"opamuser1",
            "operation":"delete"
         }
      }
   ]
}

説明:

accountUIDは、アカウントの一意識別子です。
modificationsは、変更JSONオブジェクトの配列です。
modificationは、単一の変更を表すJSONオブジェクトです。
roleは、グループにアクセス権を付与する必要があることを示します。このパラメータの値は、グループ名です。
userは、ユーザーにアクセス権を付与する必要があることを示します。このパラメータの値は、ユーザー・ログインIDです。
usagepolicyは、権限付与に適用される使用ポリシーの識別子を示します。
operationは、実行される操作のタイプを示します。有効な値は次のとおりです。
- addは権限付与を示します。
- deleteは取消しを示します。
- replaceは使用ポリシーの新しい値による置換を示します。

B.7.20 パスワードの表示

このAPIを使用して、アカウントに関連付けられたパスワードを取得および表示します。

注意:

このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者であるか、アカウントからチェックアウトしている必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/account/{accountUID}/showpassword
メソッド: GET
Content-Type: application/json
本体: NA
成功時の戻り値: ステータス・コード200およびアカウント・トークンのJSON表現

例B-60 アカウント・トークンのサンプルJSON表現

{
   "accountToken":{
      "accountName":"admin",
      "accountUID":"3f74a85e39e64432ba917a2e60fa15aa",
      "accountPassword":"GJN8p2ol"
   }
}

説明:

accountUIDは、アカウントの一意識別子です。
accountNameは、アカウントの名前です。
accountPasswordは、アカウント・パスワードです。

B.7.21 パスワードの表示(非推奨)

注意:

このAPIは非推奨となりました。第B.7.20項「パスワードの表示」のパスワードの表示APIを使用することをお薦めします。

このAPIを使用して、アカウントに関連付けられたパスワードを取得および表示します。

注意:

このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者であるか、アカウントからチェックアウトしている必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/account/{accountUID}/showpassword
メソッド: PUT
Content-Type: application/json
本体: NA
成功時の戻り値: ステータス・コード200およびアカウント・トークンのJSON表現

例B-61 アカウント・トークンのサンプルJSON表現

{
   "accountToken":{
      "accountName":"admin",
      "accountUID":"3f74a85e39e64432ba917a2e60fa15aa",
      "accountPassword":"GJN8p2ol"
   }
}

説明:

accountUIDは、アカウントの一意識別子です。
accountNameは、アカウントの名前です。
accountPasswordは、アカウント・パスワードです。

B.7.22 パスワード履歴の表示

このAPIを使用して、アカウントに関連付けられているパスワード履歴を取得および表示します。

注意:

このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者であるか、アカウントからチェックアウトしている必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/account/{accountUID}/showpasswordhistory
メソッド: GET
Content-Type: application/json
本体: NA
成功時の戻り値: ステータス・コード200およびアカウント・トークンのJSON表現

例B-62 アカウント・トークンのサンプルJSON表現

{
  "accountName": "opamuser1",
  "accountUID": "c1b054ed0f984e27bd68b8c28b985801",
  "passwordHistory": [
    {
      "accountPassword": "M7aGfNOR",
      "modificationTime": "1382996686"
    },
    {
      "accountPassword": "Dr3z5AGa",
      "modificationTime": "1382996412"
    }
  ]
}

説明:

accountUIDは、アカウントの一意識別子です。
accountNameは、アカウントの名前です。
passwordHistoryは、アカウントのパスワード履歴です。
accountPasswordは、アカウント・パスワードです。
modificationTimeは、パスワードが変更されたときの時間(UTC秒単位)です。

B.7.23 パスワード履歴の表示(非推奨)

注意:

このAPIは非推奨となりました。第B.7.22項「パスワード履歴の表示」のパスワード履歴の表示APIを使用することをお薦めします。

このAPIを使用して、アカウントに関連付けられているパスワード履歴を取得および表示します。

注意:

このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者であるか、アカウントからチェックアウトしている必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/account/{accountUID}/showpasswordhistory
メソッド: PUT
Content-Type: application/json
本体: NA
成功時の戻り値: ステータス・コード200およびアカウント・トークンのJSON表現

例B-63 アカウント・トークンのサンプルJSON表現

{
    "accountName":"admin",
    "accountUID":"3f74a85e39e64432ba917a2e60fa15aa",
    "passwordHistory": [{
            "accountPassword": "Ud2fykRx",
            "modificationTime": "2013-01-27 19:36:32.952"
        }, {
            "accountPassword": "jgs21Z8w",
            "modificationTime": "2013-01-27 19:37:02.449"
        }, {
            "accountPassword": "I3jDRaZb",
            "modificationTime": "2013-01-27 19:37:19.488"
        }, {
            "accountPassword": "5VfKaYZT",
            "modificationTime": "2013-01-28 00:22:37.331"
    }]
}

説明:

accountUIDは、アカウントの一意識別子です。
accountNameは、アカウントの名前です。
passwordHistoryは、アカウントのパスワード履歴です。
accountPasswordは、アカウント・パスワードです。
modificationTimeは、パスワードが変更された時間です。

B.7.24 パスワードのリセット

このAPIを使用してアカウントのパスワードをリセットします。

注意:

このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/account/{accountUID}/resetpassword
メソッド: GET
Content-Type: application/json
本体: 新規パスワードのJSON表現
成功時の戻り値: ステータス・コード200

例B-64 新規パスワードのサンプルJSON表現

{
   "password":"password1"
}

または

{
   "autogen":"true"
}

説明:

accountUIDは、アカウントの一意識別子です。
passwordは、アカウントに割り当てるパスワードです。
autogenは、パスワードを自動的に生成するかどうかを制御するフラグです。このフラグのデフォルト値はfalseです。

B.8 UIリソース

この項では次のAPIについて説明します。

第B.8.1項「アカウントの検索(非推奨)」
第B.8.2項「割当て済アカウントの検索(非推奨)」
第B.8.3項「すべてのチェックアウト済アカウントの取得(非推奨)」
第B.8.4項「チェックアウト済アカウント分布またはチェックアウト分布の取得」
第B.8.5項「チェックアウト済アカウント情報の取得」

B.8.1 アカウントの検索(非推奨)

注意:

このAPIは非推奨となりました。第B.7項「アカウント・リソース」のアカウントの検索APIを使用することをお薦めします。

このAPIでは、次の検索リクエスト・パラメータを1つ以上使用してアカウントを検索します。

type
domain
description
name
accountname

これらのパラメータはすべてオプションです。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロールまたはセキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/ui/allaccounts/search?param1=val1&param2=val2
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびアカウント収集のJSON表現

例B-65 アカウント収集のサンプルJSON表現

{
    "AccountCollection" : [
        {
            "account" : {
            "shared" : false,
            "targetUID" : "62bcfb98f95174ad1900ea2535989b53",
            "domain" : "needtofix",
            "targetName" : "sunds_6.3_target",
            "targetType" : "ldap",
            "accountlevelstatus" : "checkedIn",
            "description" : "",
            "accountName" : "dsperson1",
            "uri" : "https://localhost:7002/opam/account/35e2709edf0443edae8f67727d937bec",
            "accountUID" : "35e2709edf0443edae8f67727d937bec"
        }
            },
        {
            "account" : {
            "shared" : false,
            "targetUID" : "62bcfb98f95174ad1900ea2535989b53",
            "domain" : "needtofix",
            "targetName" : "sunds_6.3_target",
            "targetType" : "ldap",
            "accountlevelstatus" : "checkedIn",
            "description" : "",
            "accountName" : "dsperson10",
            "uri" : "https://localhost:7002/opam/account/0a1ee2cb17e345cdb537a2f05e11e93c",
            "accountUID" : "0a1ee2cb17e345cdb537a2f05e11e93c"
            }
        }
 
    ],
    "count" : 2
}

他のすべての属性定義は、第B.6項「ターゲット・リソース」および第B.7項「アカウント・リソース」を参照してください。

B.8.2 割当て済アカウントの検索(非推奨)

注意:

このAPIは非推奨となりました。第B.7項「アカウント・リソース」の第B.7.6項「割当て済アカウントの検索」APIを使用することをお薦めします。

このAPIを使用して割当て済アカウントを検索します。その際は、次の検索リクエスト・パラメータを1つ以上使用します。

type
domain
description
name
accountname

これらのパラメータはすべてオプションです。

URI: https://opam_server_host:opam_ssl_port/opam/ui/myaccounts/search?param1=
val1&param2=val2
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびアカウント収集のJSON表現

例B-66 アカウント収集のサンプルJSON表現

{
    "AccountCollection" : [
        {
            "account" : {
                "status" : "checkedIn",
                "shared" : false,
                "targetUID" : "62bcfb98f95174ad1900ea2535989b53",
                "domain" : "needtofix",
                "targetName" : "ldap1_target",
                "targetType" : "ldap",
                "accountlevelstatus" : "checkedIn",
                "description" : "",
                "accountName" : "person1",
                "uri" : "https://localhost:7002/opam/account/0d755f646bcf4fa08ca515ed3829aadf",
                "accountUID" : "0d755f646bcf4fa08ca515ed3829aadf"
        }
            },
        {
                "account" : {
                "status" : "checkedIn",
                "shared" : false,
                "targetUID" : "62bcfb98f95174ad1900ea2535989b53",
                "domain" : "needtofix",
                "targetName" : "ldap1_target",
                "targetType" : "ldap",
                "accountlevelstatus" : "checkedIn",
                "description" : "",
                "accountName" : "person2",
                "uri" : "https://localhost:7002/opam/account/62c684c3821f4e118790e815ee881e02",
                "accountUID" : "62c684c3821f4e118790e815ee881e02"
            }
        }
    ],
    "count" : 2
}

ここで、statusは、リクエスト元ユーザーがアカウントからチェックアウトしているのかどうかを示します。

他のすべての属性定義は、第B.6項「ターゲット・リソース」および第B.7項「アカウント・リソース」を参照してください。

B.8.3 すべてのチェックアウト済アカウントの取得(非推奨)

注意:

このAPIは非推奨となりました。第B.7項「アカウント・リソース」のすべてのチェックアウト済アカウントの取得APIを使用することをお薦めします。

このAPIを使用して、ログイン・ユーザーによってチェックアウトされたすべてのアカウントのリストを取得します。

URI: https://opam_server_host:opam_ssl_port/ui/allaccounts/mycheckedout
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびアカウント収集のJSON表現

例B-67 アカウント収集のサンプルJSON表現

{
   "AccountCollection":[
      {
         "account":{
            "uri":"https:\/\/opam_server_host:opam_ssl_port\/opam\/account\
               /3740553e999a4f6aa8e8f9286d320cb4",
            "accountUID":"3740553e999a4f6aa8e8f9286d320cb4",
            "accountName":"sherlock",
            "status":"checkedOut",
            "targetUID":"62bcfb98f95174ad1900ea2535989b53",
            "targetName":"ldap1-target",
            "targetType":"ldap",
            "domain":"berkeley",
            "expiryTime":1338765551,
         },
         "count":1
      }
   ]
}

属性定義の詳細は、第B.6項「ターゲット・リソース」および第B.7項「アカウント・リソース」を参照してください。

B.8.4 チェックアウト済アカウント分布またはチェックアウト分布の取得

このAPIを使用して、チェックアウト済アカウント分布またはチェックアウト分布を取得します。

URI: https://opam_server_host:opam_ssl_port/opam/ui/report/usage/
checkedoutdistribution? para1=value1&para2=value2&para3=value3
メソッド: GET
Content-Type: application/json
本体: NA
成功時の戻り値: ステータス・コード200およびチェックアウト済アカウント分布のJSON表現

例B-68 チェックアウト済アカウント分布のJSON出力の例

{
  "CheckoutDistribution": [
    {
      "ldap": 3
    },
    {
      "lockbox": 2
    },
    {
      "unix": 1
    }
  ]
}

説明:

orgは、ターゲットの組織です。たとえば、LDAP組織のみを検索する場合はorg=ldapと入力し、すべての組織を検索する場合はorg = nullと入力します。
typeは、チェックアウト・タイプです。たとえば、次のように入力します。
- type = password checkout: パスワードのチェックアウト分布に設定。
- type = session checkout: セッションのチェックアウト分布に設定。
- type =null: デフォルトでパスワードのチェックアウトに設定。
dis_typeは、分布タイプです。たとえば、次のように入力します。
- dis_type = checkout: パスワードまたはセッションのチェックアウト分布に設定。
- dis_type = account: (デフォルト)アカウント分布に設定。このパラメータを指定すると、(前述の) typeパラメータがOracle Privileged Account Managerによって自動的に無視されます。

B.8.5 チェックアウト済アカウント情報の取得

このAPIを使用して、チェックアウト済アカウント情報を取得します。

URI: https://opam_server_host:opam_ssl_port/opam/ui/report/usage/checkedoutaccounts
メソッド: GET
Content-Type: application/json
本体: NA
成功時の戻り値: ステータス・コード200およびチェックアウト済チェックアウト分布のJSON表現

例B-69 チェックアウト済アカウント情報のJSON出力の例

 {
            "CheckedoutAccountCollection":
            [
                {
                    "accountUID": "62bcfb98f95174ad1900ea2535989b53",
                    "targetUID": "62bcfb98f95174ad1900ea2535989b53",
                    "accountName": "OPAM_DB_ACC1",
                    "targetName": "OPAM_DB_ACC1",
                    "targetType": "database",
                    "host": "adc6170584"
                },
                {
                    "accountUID": "a044bd2aec7de5d70d73f97645db9191",
                    "targetUID": "a044bd2aec7de5d70d73f97645db9191",
                    "accountName": "cluser1",
                    "targetName": "cluser1",
                    "targetType": "ldap",
                    "host": "myhost.us.example.com"
                }
            ]
         }

B.9 ユーザー・リソース

この項では次のAPIについて説明します。

第B.9.1項「ユーザーの取得」
第B.9.2項「ユーザーに付与されているすべてのアカウントの取得」
第B.9.3項「アイデンティティ・ストアからのユーザーの検索」
第B.9.4項「割当て済ユーザーの検索」

B.9.1 ユーザーの取得

このAPIを使用してユーザーを取得します。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロールまたはセキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/user/{uid}
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびユーザーのJSON表現

例B-70 ユーザーのサンプルJSON表現

{
   "user":{
      "uid":"opamuser1",
      "lastname":"opamuser1",
      "usertype":"End-User",
      "opamrole":[
 
      ],
      "dn":"uid=opamuser1,ou=people,ou=myrealm,dc=base_domain",
   }
}

説明:

uidは、ユーザーのログインIDです。
lastnameは、ユーザーの姓です。
firstnameは、ユーザーの名前です。
dnは、ユーザーの識別名です。
usertypeは、管理ロールを持つユーザーかどうかを示します。
opamroleは、ユーザーの管理ロールです。

B.9.2 ユーザーに付与されているすべてのアカウントの取得

このAPIを使用して、ユーザーに付与されているすべてのアカウントを取得します。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロールまたはセキュリティ管理者管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/user/{uid}/accounts
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびアカウント収集のJSON表現

例B-71 アカウント収集のサンプルJSON表現

{
    "accounts":[
        {
            "account":{
            "accountUID":"16d245784350469cbe25229a7c45af22",
            "accountName":"oidperson10",
            "targetID":"75a23e9f30ba456b961a1f5d327e67ef",
            "targetName":"ldap1_target",
            "targetDomain":"needtofix",
            "targetType":"ldap"
        }
    },
        {
            "account":{
            "accountUID":"47671a7a4ebc44c496888aac5423dad1",
            "accountName":"oudperson11",
            "targetID":"488d6d656b2c4b96a5fd835c131b4c00",
            "targetName":"oud_11.115_target",
            "targetDomain":"needtofix",
            "targetType":"ldap"
        }
    }
    ]
}

属性定義の詳細は、第B.6項「ターゲット・リソース」および第B.7項「アカウント・リソース」を参照してください。

B.9.3 アイデンティティ・ストアからのユーザーの検索

このAPIを使用してユーザーを検索します。このAPIでは、ユーザーのfirstname、lastname、uidおよびmailに対してsearchKeyWordを検索します。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/user/search/{searchKeyWord}
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびユーザーのJSON表現

例B-72 ユーザーのサンプルJSON表現

{
   "users":[
      {
         "user":{
            "uid":"opamenduser1",
            "firstname":"opamenduser1",
            "lastname":"opamenduser1",
            "dn":"uid=opamenduser1,ou=people,ou=myrealm,dc=base_domain"
         }
      },
      {
         "user":{
            "uid":"opamenduser2",
            "lastname":"opamenduser2",
            "dn":"uid=opamenduser2,ou=people,ou=myrealm,dc=base_domain"
         }
      },
      {
         "user":{
            "uid":"opamuser1",
            "lastname":"opamuser1",
            "dn":"uid=opamuser1,ou=people,ou=myrealm,dc=base_domain"
         }
      }
   ]
}

属性定義の詳細は、第B.9.1項「ユーザーの取得」を参照してください。

B.9.4 割当て済ユーザーの検索

このAPIを使用してユーザーを検索します。このAPIは、uidパラメータを使用した検索を含みます。

uidパラメータはオプションです。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/user/advancedsearch?param1=val1&param2=val2
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびユーザーのJSON表現

例B-73 ユーザーのサンプルJSON表現

{
   "users":[
      {
         "user":{
            "uid":"OracleSystemUser",
            "lastname":"OracleSystemUser",
            "dn":"uid=OracleSystemUser,ou=people,ou=myrealm,dc=base_domain"
         }
      },
      {
         "user":{
            "uid":"weblogic",
         }
      },
      {
         "user":{
            "uid":"app_config",
            "lastname":"app_config",
            "dn":"uid=app_config,ou=people,ou=myrealm,dc=base_domain"
         }
      },
      {
         "user":{
            "uid":"sec_admin",
            "lastname":"sec_admin",
            "dn":"uid=sec_admin,ou=people,ou=myrealm,dc=base_domain"
         }
      },
      {
         "user":{
            "uid":"user_manager",
            "lastname":"user_manager",
            "dn":"uid=user_manager,ou=people,ou=myrealm,dc=base_domain"
         }
      },
      {
         "user":{
            "uid":"sec_auditor",
            "lastname":"sec_auditor",
            "dn":"uid=sec_auditor,ou=people,ou=myrealm,dc=base_domain"
         }
      },
      {
         "user":{
            "uid":"opamenduser1",
            "firstname":"opamenduser1",
            "lastname":"opamenduser1",
            "dn":"uid=opamenduser1,ou=people,ou=myrealm,dc=base_domain"
         }
      },
      {
         "user":{
            "uid":"opamenduser2",
            "lastname":"opamenduser2",
            "dn":"uid=opamenduser2,ou=people,ou=myrealm,dc=base_domain"
         }
      },
      {
         "user":{
            "uid":"opamuser1",
            "lastname":"opamuser1",
            "dn":"uid=opamuser1,ou=people,ou=myrealm,dc=base_domain"
         }
      }
   ]
}

属性定義の詳細は、第B.9.1項「ユーザーの取得」を参照してください。

B.10 グループ・リソース

この項では次のAPIについて説明します。

第B.10.1項「グループの取得」
第B.10.2項「グループのメンバー・ユーザーの取得」
第B.10.3項「グループのメンバー・グループの取得」
第B.10.4項「グループに付与されているすべてのアカウントの取得」
第B.10.5項「アイデンティティ・ストアからのグループの検索」
第B.10.6項「割当て済グループの拡張検索」

B.10.1 グループの取得

このAPIを使用してグループを取得します。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/group/{name}
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびグループのJSON表現

例B-74 グループのサンプルJSON表現

{
   "group":{
      "name":"opamgroup1",
      "dn":"cn=opamgroup1,ou=groups,ou=myrealm,dc=base_domain",
      "description":"",
   }
}

説明:

nameは、グループの名前です。
dnは、グループの識別名です。
descriptionは、グループの説明です。

B.10.2 グループのメンバー・ユーザーの取得

このAPIを使用してグループのユーザー・メンバーを取得します。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/group/{name}/users
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびユーザー収集のJSON表現

例B-75 ユーザー収集のサンプルJSON表現

{
    "users":[
        {
            "user":{
            "uid":"master_user",
            "lastname":"master_user",
            "dn":"uid=master_user,ou=people,ou=myrealm,dc=base_domain"
        }
    },
        {
            "user":{
            "uid":"sec_admin",
            "lastname":"sec_admin",
            "dn":"uid=sec_admin,ou=people,ou=myrealm,dc=base_domain"
        }
    }
    ]
}

属性定義の詳細は、第B.9.1項「ユーザーの取得」を参照してください。

B.10.3 グループのメンバー・グループの取得

このAPIを使用してグループのグループ・メンバーを取得します。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/group/{name}/groups
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびグループ収集のJSON表現

例B-76 グループ収集のサンプルJSON表現

{
    "groups":[
        {
            "group":{
                "name":"CrossDomainConnectors",
                "description":"CrossDomainConnectors can make inter-domain calls from foreign domains."
            }
        },
       {
            "group":{
               "name":"Deployers",
               "description":"Deployers can view all resource attributes and deploy applications."
        }
    }
    ]
}

属性定義の詳細は、第B.10.1項「グループの取得」を参照してください。

B.10.4 グループに付与されているすべてのアカウントの取得

このAPIを使用して、グループに付与されているすべてのアカウントを取得します。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/group/{name}/accounts
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびアカウント収集の表現

例B-77 アカウント収集のサンプルJSON表現

{
    "accounts":[
        {
            "account":{
            "accountUID":"16d245784350469cbe25229a7c45af22",
            "accountName":"oidperson10",
            "targetID":"75a23e9f30ba456b961a1f5d327e67ef",
            "targetName":"ldap1_target",
            "targetDomain":"needtofix",
            "targetType":"ldap"
            }
        },
        {
            "account":{
            "accountUID":"47671a7a4ebc44c496888aac5423dad1",
            "accountName":"oudperson11",
            "targetID":"488d6d656b2c4b96a5fd835c131b4c00",
            "targetName":"oud_11.115_target",
            "targetDomain":"needtofix",
            "targetType":"ldap"
            }
        }
        ]
}

属性定義の詳細は、第B.6項「ターゲット・リソース」および第B.7項「アカウント・リソース」を参照してください。

B.10.5 アイデンティティ・ストアからのグループの検索

このAPIを使用してグループを検索します。このAPIでは、グループ名に対してsearchKeyWordを検索します。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/group/search/{searchKeyWord}
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびグループのJSON表現

例B-78 グループのサンプルJSON表現

{
   "groups":[
      {
         "group":{
            "name":"opamgroup1",
            "description":"",
         }
      },
      {
         "group":{
            "name":"opamgroup2",
            "description":"",
         }
      },
      {
         "group":{
            "name":"opamsubgroup1",
            "description":"",
         }
      },
      {
         "group":{
            "name":"opamsubgroup2",
            "description":"",
         }
      },
      {
         "group":{
            "name":"OPAM_APPLICATION_CONFIGURATOR",
            "description":"OPAM_APPLICATION_CONFIGURATOR",
         }
      },
      {
         "group":{
            "name":"OPAM_SECURITY_ADMIN",
            "description":"OPAM_SECURITY_ADMIN",
         }
      },
      {
         "group":{
            "name":"OPAM_SECURITY_AUDITOR",
            "description":"OPAM_SECURITY_AUDITOR",
         }
      },
      {
         "group":{
            "name":"OPAM_USER_MANAGER",
            "description":"OPAM_USER_MANAGER",
         }
      }
   ]
}

属性定義の詳細は、第B.10.1項「グループの取得」を参照してください。

B.10.6 割当て済グループの拡張検索

このAPIを使用してアカウントに割り当てられているグループを検索します。リクエスト・パラメータはgroupnameです。これはオプションです。

注意:

このAPIを使用するには、「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/group/advancedsearch?param1=val1&param2=val2.
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびグループのJSON表現

例B-79 グループのサンプルJSON表現

{
   "groups":[
      {
         "group":{
            "name":"opamgroup1",
            "description":"",
         }
      },
      {
         "group":{
            "name":"opamgroup2",
            "description":"",
         }
      },
      {
         "group":{
            "name":"opamsubgroup1",
            "description":"",
         }
      },
      {
         "group":{
            "name":"opamsubgroup2",
            "description":"",
         }
      },
      {
         "group":{
            "name":"OPAM_APPLICATION_CONFIGURATOR",
            "description":"OPAM_APPLICATION_CONFIGURATOR",
         }
      },
      {
         "group":{
            "name":"OPAM_SECURITY_ADMIN",
            "description":"OPAM_SECURITY_ADMIN",
         }
      },
      {
         "group":{
            "name":"OPAM_SECURITY_AUDITOR",
            "description":"OPAM_SECURITY_AUDITOR",
         }
      },
      {
         "group":{
            "name":"OPAM_USER_MANAGER",
            "description":"OPAM_USER_MANAGER",
         }
      }
   ]
}

属性定義の詳細は、第B.10.1項「グループの取得」を参照してください。

B.11 リソース・グループ・リソース

この項では次のAPIについて説明します。

第B.11.1項「リソース・グループの作成」
第B.11.2項「リソース・グループの検索」
第B.11.3項「リソース・グループの表示」
第B.11.4項「リソース・グループの更新」
第B.11.5項「リソース・グループの削除」
第B.11.6項「委任の作成または削除」
第B.11.7項「リソース・グループの委任の表示」

B.11.1 リソース・グループの作成

このAPIを使用して、リソース・グループを作成します。

注意:

リソース・グループを作成するには、「セキュリティ管理者」管理ロールを持つ管理者である必要があります。
「セキュリティ管理者」管理ロールを委任されている場合は、このAPIを使用して、委任されたリソース・グループの配下にリソース・グループを作成できます(memberofオプションを使用)。

URI: https://opam_server_host:opam_ssl_port/opam/resourcegroup
メソッド: POST
Content-Type: application/json
本体: リソース・グループの追加のJSON表現
成功時の戻り値: ステータス・コード200およびコネクタ・サーバーのJSON表現
失敗時の戻り値: NA

例B-80 リソース・グループのサンプルJSON表現

{
    "resourcegroup": {
        "resourcegroupname":"rg1",
        "description":"this is the description of the resource group"
    }
}

{
   "resourcegroup":{
      "resourcegroupname":"rg1",
      "description":"this is a resource group",
      "members":[
         {
            "member":{
               "memberid":"26894a8fadc8448b9bf01eb6f52402c1",
               "membertype":"account"
            }
         },
         {
            "member":{
               "memberid":"fcc6ec6530174fcb94b066e3dc1469e4",
               "membertype":"account"
            }
         },
         {
            "member":{
               "memberid":"0542ef9600e6479a8597ec1f8479276e",
               "membertype":"resourcegroup"
            }
         },
         {
            "member":{
               "memberid":"fc142a16c1c04148923049c8798abfdb",
               "membertype":"target"
            }
         }
      ]
   }
}

説明:

orgはターゲット組織です(org = nullでは、すべての組織が検索されます)。
typeは、パスワードのチェックアウトまたはセッションのチェックアウトです。このパラメータを使用して、パスワードのチェックアウト分布またはセッションのチェックアウト分布を指定します(type=nullでは、デフォルトでパスワードのチェックアウトに設定されます)。
dis_typeは、分布タイプ(チェックアウト済アカウント分布またはチェックアウト分布のいずれか)です。(デフォルトはアカウント分布です)。dis_type = checkoutを使用すると、パスワードまたはセッションのチェックアウト分布を選択でき、dis_type = accountを使用すると、前述のパラメータ・タイプが自動的に無視されます。

B.11.2 リソース・グループの検索

このAPIを使用して、リソース・グループを検索します。

注意:

リソース・グループを検索するには、「セキュリティ管理者」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/resourcegroup/{resourcegroupUID}
メソッド: NA
Content-Type: NA
本体: NA
成功時の戻り値: NA
失敗時の戻り値: NA

B.11.3 リソース・グループの表示

このAPIを使用して、リソース・グループを表示します。

注意:

リソース・グループを表示するには、「セキュリティ管理者」管理ロールまたは「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/resourcegroup/{resourcegroupUID}
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびリソース・グループのJSON表現
成功時の戻り値: NA

例B-81 リソース・グループのサンプルJSON表現

{
   "resourcegroup":{
      "resourcegroupid":"ae43b6e6dd664ee1b8a547f44f3278e8",
      "resourcegroupname":"rg1",
      "description":"updated description for rg1",
      "members":[
         {
            "member":{
               "memberid":"26894a8fadc8448b9bf01eb6f52402c1",
               "membername":"a1",
               "membertype":"account"
            }
         },
         {
            "member":{
               "memberid":"fcc6ec6530174fcb94b066e3dc1469e4",
               "membername":"a2",
               "membertype":"account"
            }
         },
         {
            "member":{
               "memberid":"0542ef9600e6479a8597ec1f8479276e",
               "membername":"rg2",
               "membertype":"resourcegroup"
            }
         },
         {
            "member":{
               "memberid":"f433674a53c448f9ae820f12995ba51d",
               "membername":"t1",
               "membertype":"target"
            }
         }
      ]
   }
}

B.11.4 リソース・グループの更新

このAPIを使用して、リソース・グループを更新します(説明の変更、リソース・グループのメンバーの追加および削除など)。

注意:

リソース・グループを更新するには、「セキュリティ管理者」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/resourcegroup/{resourcegroupUID}
メソッド: PUT
Content-Type: application/json
本体: リソース・グループの変更のJSON表現
成功時の戻り値: ステータス・コード200

例B-82 リソース・グループの変更のサンプルJSON表現

{
   "modifications":[
      {
         "modification":{
            "description":"updated description"
         }
      },
      {
         "modification":{
            "members":{
               "operation":"add",
               "memberid":"1001",
               "membertype":"account"
            }
         }
      },
      {
         "modification":{
            "members":{
               "operation":"delete",
               "memberid":"1001"
            }
         }
      }
   ]
}

B.11.5 リソース・グループの削除

このAPIを使用して、リソース・グループを削除します。

注意:

リソース・グループを削除するには、「セキュリティ管理者」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/resourcegroup/{resourcegroupUID}
メソッド: DELETE
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200
失敗時の戻り値: NA

B.11.6 委任の作成または削除

このAPIを使用して、リソース・グループの委任を作成します。

注意:

リソース・グループの委任を作成または削除するには、「セキュリティ管理者」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/resourcegroup/{resourcegroupUID}
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200
失敗時の戻り値: NA

例B-83 リソース・グループのサンプルJSON表現

{
   "modifications":[
      {
         "modification":{
            "delegations":{
               "operation":"add",
               "delegatee":"opam_user1",
               "delegatee_type":"user",
               "privilege":"security_admin"
            }
         }
      },
      {
         "modification":{
            "delegations":{
               "operation":"add",
               "delegatee":"opam_admins",
               "delegatee_type":"role",
               "privilege":"user_manager"
            }
         }
      },
      {
         "modification":{
            "delegations":{
               "operation":"delete",
               "delegatee":"opam_user2",
               "delegatee_type":"user",
               "privilege":"security_admin"
            }
         }
      }
   ]
}

B.11.7 リソース・グループの委任の表示

このAPIを使用して、リソース・グループの委任を表示します。

注意:

リソース・グループの委任を表示するには、「セキュリティ管理者」管理ロールを持つ管理者である必要があります。

URI: https://opam_server_host:opam_ssl_port/opam/resourcegroup/{resourcegroupUID}/
delegations
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびリソース・グループのJSON表現
失敗時の戻り値: NA

例B-84 リソース・グループの委任のサンプルJSON表現

{
   "resourcegroup":{
      "resourcegroupid":"139b052b2d1649aa89964b4bafd2476a",
      "resourcegroupname":"rg2",
      "description":"updated description for rg1",
      "delegations":[
         {
            "delegation":{
               "delegatee":"opam_user1",
               "delegatee_type":"user",
               "privilege":"security_admin"
            }
         },
         {
            "delegation":{
               "delegatee":"opam_user2",
               "delegatee_type":"user",
               "privilege":"security_admin"
            }
         },
         {
            "delegation":{
               "delegatee":"opam_admins",
               "delegatee_type":"role",
               "privilege":"user_manager"
            }
         }
      ]
   }
}

B.12 プラグイン・リソース

この項では次のAPIについて説明します。

第B.12.1項「プラグイン構成の追加」
第B.12.2項「プラグイン構成の検証」
第B.12.3項「プラグイン構成の検索」
第B.12.4項「プラグイン構成の取得」
第B.12.5項「プラグイン構成の更新」
第B.12.6項「プラグイン構成の削除」

B.12.1 プラグイン構成の追加

このAPIを使用してプラグイン構成を追加します。

URI: https://opam_server_host:opam_ssl_port/opam/plugin
メソッド: POST
Content-Type: application/json
本体: プラグインのJSON表現
成功時の戻り値: ステータス・コード201および場所
エラーでの戻り値: NA

例B-85 プラグイン構成の作成のサンプルJSON表現

{
    "plugin": {
        "pluginName":"sampleplugin"
        "pluginDescription":"Sample Plugin"
        "pluginEnabled": "true"
        "pluginResource":"account"
        "pluginOperation":"checkout"
        "pluginTiming":"post"
        "pluginOrder":"10"
        "pluginClassName":"EmailNotifyPlugin"
        "pluginClassPath":"/u01/plugins/emailplugin.jar"
        "pluginEnableGroup":["hrgroup", "itgroup"]
        "pluginEnableUser":["admin"]
        "pluginEnableResult":"200"
        "pluginVersion":"1.0.0"
        "pluginCustomAttrs":[
            {
                "pluginCustomAttr": {
                    "attrname":"notificationemail"
                    "attrvalue":"abc@abc.com"
                }
            }
        ]
    }
}

サンプル出力

https://opam_server_host:opam_ssl_port/opam/plugin/9bbcbbb087174ad1900ea691a2573b61

B.12.2 プラグイン構成の検証

このAPIを使用してプラグイン構成を検証します。その内容は次のとおりです。

pluginNameの一意性のテスト
pluginResource、pluginOperation、pluginOrderの組合せの一意性のテスト
属性および許容値の検証
pluginClassPathを使用したpluginClassNameのロードの検証

APIは次のとおりです。

URI: https://opam_server_host:opam_ssl_port/opam/plugin/test
メソッド: PUT
Content-Type: application/json
本体: プラグインのJSON表現
成功時の戻り値: ステータス・コード200
エラーでの戻り値: NA

例B-86 検証のためのプラグイン構成のサンプルJSON表現

{
    "plugin": {
        "pluginUID":"9bbcbbb087174ad1900ea691a2573b61"
        "pluginName":"sampleplugin"
        "pluginDescription":"Sample Plugin"
        "pluginEnabled": "true"
        "pluginResource":"account"
        "pluginOperation":"checkout"
        "pluginTiming":"post"
        "pluginOrder":"10"
        "pluginClassName":"EmailNotifyPlugin"
        "pluginClassPath":"/u01/plugins/emailplugin.jar"
        "pluginEnableGroup":["hrgroup", "itgroup"]
        "pluginEnableUser":["admin"]
        "pluginEnableResult":"200"
        "pluginVersion":"1.0.0"
        "pluginCustomAttrs":[
            {
                "pluginCustomAttr": {
                    "attrname":"notificationemail"
                    "attrvalue":"abc@abc.com"
                }
            }
        ]
    }
}

B.12.3 プラグイン構成の検索

このAPIを次のパラメータのいずれかとともに使用して、プラグイン構成を検索します。

名前
説明
有効
リソース
操作
タイミング

APIは次のとおりです。

URI: https://opam_server_host:opam_ssl_port/opam/plugin
/search?param1=value1&param2=value2
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびプラグイン収集のJSON表現

サンプルURI

https://opam_server_host:opam_ssl_port/opam/plugin
/search?name=email&enabled=true&timing=post

例B-87 プラグイン収集のサンプルJSON表現

{"pluginCollection": [
    {"plugin": {
        "pluginUID":"9bbcbbb087174ad1900ea691a2573b61"
        "pluginDescription":"Sample Plugin"
        "pluginName":"sampleplugin"
        "pluginEnabled": "true"
        "pluginResource":"account"
        "pluginOperation":"checkout"
        "pluginTiming":"post"
        "pluginOrder":"10"
        "pluginClassName":"EmailNotifyPlugin"
        "pluginClassPath":"/u01/plugins/emailplugin.jar"
        "pluginEnableGroup":["hrgroup", "itgroup"]
        "pluginEnableUser":["admin"]
        "pluginEnableResult":"200"
        "pluginVersion":"1.0.0"
        "pluginCustomAttrs":[
            {
                "pluginCustomAttr": {
                    "attrname":"notificationemail"
                    "attrvalue":"abc@abc.com"
                }
            }
        ]
    }}
   ]
}

B.12.4 プラグイン構成の取得

このAPIを使用してプラグイン構成を取得します。

URI: https://opam_server_host:opam_ssl_port/opam/plugin
/plugin/{pluginUID}
メソッド: GET
Content-Type: NA
本体: NA
成功時の戻り値: ステータス・コード200およびプラグインのJSON表現

例B-88 プラグインのサンプルJSON表現

{
    "plugin": {
        "pluginUID":"9bbcbbb087174ad1900ea691a2573b61"
        "pluginName":"sampleplugin"
        "pluginDescription":"Sample Plugin"
        "pluginEnabled": "true"
        "pluginResource":"account"
        "pluginOperation":"checkout"
        "pluginTiming":"post"
        "pluginOrder":"10"
        "pluginClassName":"EmailNotifyPlugin"
        "pluginClassPath":"/u01/plugins/emailplugin.jar"
        "pluginEnableGroup":["hrgroup", "itgroup"]
        "pluginEnableUser":["admin"]
        "pluginEnableResult":"200"
        "pluginVersion":"1.0.0"
        "pluginCustomAttrs":[
            {
                "pluginCustomAttr": {
                    "attrname":"notificationemail"
                    "attrvalue":"abc@abc.com"
                }
            }
        ]
    }
}

B.12.5 プラグイン構成の更新

このAPIを使用してプラグイン構成を更新します。

URI: https://opam_server_host:opam_ssl_port/opam/plugin/{pluginUID}
メソッド: PUT
Content-Type: application/json
本体: プラグインの変更のJSON表現
成功時の戻り値: ステータス・コード200

例B-89 プラグイン変更のサンプルJSON表現

{
    "modifications": [
        {
             "modification": {
                 "pluginEnabled":"false"
                 "pluginVersion": "1.0.1"
            }
        }
    ]
}

B.12.6 プラグイン構成の削除

このAPIを使用してプラグイン構成を削除します。

URI: https://opam_server_host:opam_ssl_port/opam/plugin/{pluginUID}
メソッド: DELETE
Content-Type: application/json
本体: NA
成功時の戻り値: ステータス・コード200