Oracle® Fusion Middleware Oracle Privileged Account Manager管理者ガイド 11g リリース2 (11.1.2) B69534-04 |
|
![]() 前 |
![]() 次 |
Oracle Privileged Account Managerはいくつかのクライアント・インタフェースを介して使用できますが、その基本となるアクセス・メカニズムまたはレイヤーは、RESTfulインタフェースにカプセル化されています。
外部パーティ(Oracle Privileged Account Manager以外のサーバーなど)によって使用されるOracle Privileged Account Managerサーバーとのすべての相互作用は、RESTfulインタフェースを介して公開されます。外部から参照可能なすべてのOracle Privileged Account Managerリソースは、URIでモデル化されますが、標準のHTTP操作はそれらのリソースに対する、関連するOracle Privileged Account Manager操作にマップされます。
この付録では、Oracle Privileged Account ManagerのRESTfulインタフェースについて説明します。このインタフェースを介して公開される特定のAPIについて、次の項で説明します。
注意: 次の項に記載されている説明は、Oracle Privileged Account ManagerをWebLogicとIBM WebSphereのどちらで使用しようとも基本的には同じですが、少々異なる点もいくつかあります。 詳細は、『Oracle Fusion Middleware Oracle Identity and Access Managementサードパーティ・アプリケーション・サーバー・ガイド』のIBM WebSphere上でOracle Privileged Account Managerコマンドライン・ツールとRESTインタフェースを使用する場合の相違点に関する項を参照してください。 |
注意: Oracle Privileged Account ManagerのWebベースのコンソールまたはコマンドライン・ツールを使用して、この付録で説明しているタスクを実行することもできます。 詳細は、第5章「Oracle Privileged Account Managerの構成および管理」または付録A「コマンドライン・ツールの使用」を参照してください。 |
この項では、サーバー状態の取得APIについて説明します。
このAPIを使用して、サーバーのステータスに関する情報を取得します。
URI |
https://opam_server_host:opam_ssl_port/opam/ |
メソッド |
|
Content-Type |
|
成功時の戻り値 |
ステータス・コード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" }
説明:
RequestorGroupsは、リクエストを作成しているユーザーに割り当てられているグループです。
Requestorは、リクエストを作成しているユーザーです。
StatusCodeは、サーバーが正常に動作しているかどうかを示します。
サーバーが正常に動作している場合は、ゼロ(0)が返されます。
なんらかの問題が発生している場合は、ゼロ以外の整数値が返されます。
Statusは、サーバーの状態に関する情報メッセージです。
この項では次のAPIについて説明します。
このAPIを使用して、構成オブジェクトを取得します。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロール、セキュリティ管理者管理ロールまたは「アプリケーション構成者」管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/config/configid |
メソッド |
|
Content-Type |
|
成功時の戻り値 |
200および |
サンプルURI
https://opam_server_host:opam_ssl_port/opam/config/globalconfig
例B-2 configオブジェクトのサンプルJSON表現
{ "config":{ "configUID":"globalconfig", "configType":"config_globalconfig", "tdemode":[ "true" ], "policyenforcerinterval":[ "3600" ], "passwordcyclerinterval":[ "3600" ] } }
説明:
configUIDは、config
オブジェクトの一意の識別子です。
configTypeは、config
オブジェクトのタイプです。
policyenforcerintervalは、Oracle Privileged Account Managerがアカウントを確認し、「使用ポリシー」で定義されている有効期限を過ぎているアカウントを自動的にチェックインする時間隔(秒)です。
passwordcyclerintervalは、Oracle Privileged Account Managerがアカウントのパスワード確認し、「パスワード・ポリシー」で定義されている最大パスワード期間を超えているパスワードをリセットする時間隔(秒)です。
tdemodeは、Oracle Privileged Account ManagerでTDEまたは非TDEモードを使用することを求めるリクエストに対するフラグです。
このAPIを使用して、構成オブジェクトを変更します。
注意: このAPIを使用するには、「アプリケーション構成者」管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/config/configid |
メソッド |
|
Content-Type |
application/json |
本体 |
変更のJSON表現 |
成功時の戻り値 |
ステータス・コード200 |
説明:
modificationsは、変更JSONオブジェクトの配列です。
modificationは、単一の構成オブジェクトの変更を表すJSONオブジェクトです。
tdemodeは、Oracle Privileged Account ManagerでTDEまたは非TDEモードを使用することを求めるリクエストに対するフラグです。
この項では次のAPIについて説明します。
このAPIを使用して、すべてのターゲット・タイプに関連付けられた属性のリストを取得します。
サポートされるターゲット・タイプのリストをこれらの属性とともに使用して、ターゲットを追加するために必要なJSONオブジェクトを作成します。詳細は、B.3.2項「ターゲットの追加」を参照してください。
URI |
https://opam_server_host:opam_ssl_port/opam/target/attributes |
メソッド |
|
Content-Type |
|
成功時の戻り値 |
ステータス・コード200、ターゲット・タイプのJSON表現、およびそれらに関連付けられた属性 |
サンプルURI
https://opam_server_host:opam_ssl_port/opam/target/attributes
例B-4 サポートされているターゲット・タイプと属性のJSON表記の出力
{ "TargetAttributes":[ { "TargetType":"ldap", "DisplayName":"ldap", "BasicAttributes":[ { "name":"targetName", "type":"string", "description":"", "label":"Target Name", "mask":"false", "array":"false", "required":"true" }, { "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
を指定します。
注意: このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/target |
メソッド |
|
Content-Type |
application/json |
本体 |
ターゲットの追加またはテストのJSON表現 |
成功時の戻り値 |
ステータス・コード201 (作成)および場所 |
例B-5 ターゲットの追加のサンプルJSON表現(ldap TargetType)
{ "target":{ "targetType":"ldap", "targetName":"person1-ldap2", "host":"opam_server_host", "passwordpolicy" : "passwordpolicy1", "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-6 ターゲットの追加のサンプルJSON表現(database TargetType)
{ "target" : { "targetType" : "database", "targetName" : "db112_target", "passwordpolicy" : "passwordpolicy1", "host" : "afg1140282", "domain" : "adc1140282Domain", "description" : "Dbase target for the automation", "connectionProperties" : "", "dbType" : "Oracle", "jdbcUrl" : "jdbc:oracle:thin:@afg1140282.us.pk.com:11227:db5474", "loginPassword" : "welcome1", "loginUser" : "system" } }
例B-7 ターゲットの追加のサンプルJSON表現(unix TargetType)
{ "target" : { "targetType" : "unix", "targetName" : "BackUpUnixTarget", "passwordpolicy" : "passwordpolicy1", "host" : "adc0345lsdf.us.idc.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" : "welcome1", "loginUser" : "aime2" } }
サンプル出力
https://opam_server_host:opam_ssl_port/opam/target
/9bbcbbb087174ad1900ea691a2573b61 (場所)
説明:
targetは、ターゲットJSONオブジェクトです。
targetNameは、ターゲットの名前です。
targetTypeは、ターゲット・タイプです。
passwordpolicyは、ターゲットに適用されているパスワード・ポリシーのパスワード・ポリシーIDです。
他のすべての属性は、動的であり、B.3.1項「ターゲット属性の取得」の属性に対応します。
URI |
https://opam_server_host:opam_ssl_port/opam/target/test |
メソッド |
|
Content-Type |
application/json |
本体 |
ターゲットの追加またはテストのJSON表現 |
成功時の戻り値 |
ステータス・コード200 |
例B-8 ターゲットの追加または検証のサンプルJSON表現
{ "target":{ "targetType":"ldap", "targetName":"person1-ldap2", "host":"opam_server_host", "passwordpolicy" : "passwordpolicy1", "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.3.1項「ターゲット属性の取得」の属性に対応します。
URI |
https://opam_server_host:opam_ssl_port/opam/target/{targetUID} |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200およびターゲットのJSON表現 |
例B-9 ターゲットのサンプルJSON表現(ldap TargetType)
{ "target":{ "targetUID":"9bbcbbb087174ad1900ea691a2573b61", "targetType":"ldap", "targetName":"person1-ldap", "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-10 ターゲットのサンプルJSON表現(database TargetType)
{ "target" : { "targetUID" : "62bcfb98f95d4966ab0ff9a44717a20a", "targetType" : "database", "targetName" : "db112_target", "passwordpolicy" : "passwordpolicy1", "host" : "afg1140282", "domain" : "adc1140282Domain", "description" : "Dbase target for the automation", "connectionProperties" : "", "dbType" : "Oracle", "jdbcUrl" : "jdbc:oracle:thin:@afg1140282.us.pk.com:11227:db5474", "loginPassword" : "welcome1", "loginUser" : "system" } }
例B-11 ターゲットのサンプルJSON表現(unix TargetType)
{ "target" : { "targetUID" : "a00075b4b7bb453c9482d02535989b53", "targetType" : "unix", "targetName" : "BackUpUnixTarget", "passwordpolicy" : "passwordpolicy1", "host" : "adc0345lsdf.us.idc.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" : "welcome1", "loginUser" : "aime2" } }
説明:
targetは、ターゲットJSONオブジェクトです。
targetUIDは、ターゲットの一意識別子です。
targetNameは、ターゲットの名前です。
targetTypeは、ターゲット・タイプです。
他のすべての属性は、動的であり、B.3.1項「ターゲット属性の取得」の属性に対応します。
注意: このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。 |
targetType
およびtargetUID
を除くすべての属性の変更が可能で、同時に複数の属性を変更できます。
URI |
https://opam_server_host:opam_ssl_port/opam/target/{targetUID} |
メソッド |
|
Content-Type |
application/json |
本体 |
ターゲット変更のJSON表現 |
成功時の戻り値 |
ステータス・コード200 |
例B-12 ターゲット変更のサンプルJSONオブジェクト
"modifications":[
{
"modification":{
"host":"opam_server_host
}
},
{
"modification":{
"port":"6000"
}
}
]
}
説明:
targetUIDは、ターゲットの一意識別子です。
modificationsは、変更JSONオブジェクトの配列です。
modificationは、単一属性の変更を表すJSONオブジェクトです。
注意: このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/target/{targetUID} |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200 |
このAPIでは、次のリクエスト・パラメータのいずれかを使用してターゲットを検索します。
type
name
hostname
domain
description
org
これらのパラメータはすべてオプションです。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロール、セキュリティ管理者管理ロールまたは「セキュリティ監査者」管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/target/search?param1=value1¶m2=value2 |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード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に |
例B-13 ターゲット収集のサンプル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は、ターゲット・システムの説明です。
このAPIを使用して、ターゲット・システムに存在するすべてのアカウントを取得します。
注意: このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/target/{targetUID}/availableaccounts |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200 (OK)およびアカウント収集のJSON表現 |
例B-14 アカウント収集のサンプルJSON表現
{ "AvailableAccounts":[ { "accountName":"SCOTT", "accountUid":"SCOTT" }, { "accountName":"BLAKE", "accountUid":"BLAKE " }, { "accountName":"JONES", "accountUid":"JONES" } ] }
説明:
AvailableAccountsは、ターゲット・システムに存在するアカウントの配列です。
accountNameは、アカウント名です。
accountUIDは、アカウントの一意識別子です。
このAPIを使用して、ターゲットでOracle Privileged Account Managerに登録されているすべてのアカウントを取得します。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロール、セキュリティ管理者管理ロールまたは「セキュリティ監査者」管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/target/{targetUID}/accounts |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200およびアカウントのURI収集のJSON表現 |
例B-15 アカウントの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は、アカウント名です。
このAPIを使用して、サポートされるすべてのターゲット・タイプのリストを取得します。
URI |
https://opam_server_host:opam_ssl_port/opam/target/types |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200およびサポートされるターゲット・タイプのJSON表現 |
説明:
targettypesは、サポートされるターゲット・タイプです。
このAPIを使用して、サービス・アカウントでパスワードをリセットします。
注意: このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/target/{targetUID}/resetpassword |
メソッド |
|
Content-Type |
application/json |
本体 |
|
成功時の戻り値 |
ステータス・コード200 |
説明:
targetUIDは、ターゲットの一意識別子です。
passwordは、サービス・アカウントに割り当てるパスワードです。
autogenは、パスワードを自動的に生成するかどうかを制御するフラグです。(デフォルトはfalse
です。)
このAPIを使用して、サービス・アカウント・パスワードを取得して表示します。
注意: このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/target/{targetUID}/showpassword |
メソッド |
|
Content-Type |
application/json |
本体 |
|
成功時の戻り値 |
ステータス・コード200およびサービス・アカウントのJSON表現 |
例B-18 アカウント・トークンのサンプルJSON表現
{ "serviceAccount" : { "targetName" : "APILDAP", "targetUID" : "ad3163bfb37b4544a4c12ae06a39c2d9", "targetAccount" : "cn=admin", "targetPassword" : "welcome1", "targetPasswordChangeTime" : " 2013-01-27 02:58:13.259" } }
説明:
targetUIDは、ターゲットの一意識別子です。
targetNameは、ターゲットの名前です。
targetAccountは、ターゲットのサービス・アカウントです。
targetPasswordは、サービス・アカウント・パスワードです。
targetPasswordChangeTimeは、パスワードの変更時間です。
この項では次のAPIについて説明します。
このAPIを使用してターゲットにアカウントを追加します。このAPIは、ターゲット・システムにアカウントを作成しませんが、既存のアカウントをOracle Privileged Account Managerターゲットに登録します。
注意:
|
URI |
https://opam_server_host:opam_ssl_port/opam/account |
メソッド |
|
Content-Type |
application/json |
本体 |
アカウントの追加または検証のJSON表現 |
成功時の戻り値 |
ステータス・コード201および場所 |
例B-19 アカウントの追加または検証のサンプルJSON表現
{ "account":{ "accountName":"admin", "description" : "maintenance account on the machine", "password" : "welcome1", "passwordpolicy":"passwordpolicy2", "shared":"true", "targetUID":"9bbcbbb087174ad1900ea691a2573b61" } }
説明:
accountは、アカウントJSONオブジェクトです。
accountNameは、アカウントの名前です。
descriptionは、アカウントの説明です。この属性はオプションlです。
passwordは、アカウント・パスワードです。この属性はオプションlです。
passwordpolicyは、アカウントに適用可能なパスワード・ポリシーのポリシーIDです。このパラメータはオプションです。デフォルトでは、このパラメータはグローバル・デフォルト・パスワード・ポリシーを使用します。
sharedは、アカウントの共有ステータスを示します。この値はブール値であり、デフォルト設定はfalse
です。
targetUIDは、ターゲットの一意識別子です。
このAPIを使用して、アカウントがターゲット・システムに存在するかどうかを検証します。
URI |
https://opam_server_host:opam_ssl_port/opam/account/test |
メソッド |
|
Content-Type |
application/json |
本体 |
アカウントの追加または検証のJSON表現 |
成功時の戻り値 |
ステータス・コード200 |
例B-20 アカウントの追加または検証のサンプルJSON表現
{ "account":{ "accountName":"admin", "description" : "maintenance account on the machine" "password" : "welcome1" "passwordpolicy":"passwordpolicy2", "shared":"true", "targetUID":"9bbcbbb087174ad1900ea691a2573b61" } }
説明:
accountは、アカウントJSONオブジェクトです。
accountNameは、アカウントの名前です。
descriptionは、アカウントの説明です。この属性はオプションlです。
passwordは、アカウント・パスワードです。この属性はオプションlです。
passwordpolicyは、アカウントに適用可能なパスワード・ポリシーのポリシーIDです。このパラメータはオプションです。デフォルトでは、このパラメータはグローバル・デフォルト・パスワード・ポリシーを使用します。
sharedは、アカウントの共有ステータスを示します。この値はブール値であり、デフォルト設定はfalse
です。
targetUIDは、ターゲットの一意識別子です。
URI |
https://opam_server_host:opam_ssl_port/opam/account/{accountUID} |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200およびアカウントのJSON表現 |
例B-21 アカウントのサンプルJSON表現
{ "account":{ "accountUID":"3f74a85e39e64432ba917a2e60fa15aa", "targetUID":"9bbcbbb087174ad1900ea691a2573b61", "accountName":"admin", "shared":true, "accountlevelstatus":"checkedIn", "passwordpolicy":"passwordpolicy2", } }
説明:
accountは、アカウントJSONオブジェクトです。
accountUIDは、アカウントの一意識別子です。
accountNameは、アカウントの名前です。
passwordpolicyは、アカウントに適用可能なパスワード・ポリシーのポリシーIDです。
sharedは、アカウントの共有ステータスを示します。この値はブール値であり、デフォルト設定はfalse
です。
targetUIDは、ターゲットの一意識別子です。
accountlevelstatusは、アカウントがユーザーによってチェックインされたかどうかを示します。有効な値は、checkedIn
およびcheckedOut
です。
このAPIを使用してアカウントのパスワードをリセットします。
注意: このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/account/{accountUID}/resetpassword |
メソッド |
|
Content-Type |
application/json |
本体 |
新規パスワードのJSON表現 |
成功時の戻り値 |
ステータス・コード200 |
説明:
accountUIDは、アカウントの一意識別子です。
passwordは、アカウントに割り当てるパスワードです。
autogenは、パスワードを自動的に生成するかどうかを制御するフラグです。(デフォルトはfalse
です。)
このAPIを使用してアカウントを更新します。同時に複数の属性を変更できます。passwordpolicy、descriptionおよびshared属性のみ更新できます。
注意: このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/account/{accountUID} |
メソッド |
|
Content-Type |
application/json |
本体 |
アカウント変更のJSON表現 |
成功時の戻り値 |
ステータス・コード200 |
例B-23 アカウント変更のサンプルJSON表現
{ "modifications":[ { "modification":{ "passwordpolicy":"passwordpolicy2" } }, { "modification":{ "shared":"false" } } } }
説明:
accountUIDは、アカウントの一意識別子です。
modificationsは、変更JSONオブジェクトの配列です。
modificationは、単一属性の変更を表すJSONオブジェクトです。
このAPIを使用して、アカウントの適用可能な使用ポリシーを取得します。
URI |
https://opam_server_host:opam_ssl_port/opam/account/ |
メソッド |
|
Content-Type |
|
成功時の戻り値 |
ステータス・コード200および使用ポリシーのJSON表現 |
例B-24 使用ポリシーのサンプルJSON表現
{"usagepolicy": { "policyid":"bafd53072bbb442db185dca18bd00e69", "policyname":"usage_policy_anytime" } }
説明:
usagepolicyは、使用ポリシーJSONオブジェクトです。
policyidは、使用ポリシーの一意識別子です。
policynameは、ポリシーの名前です。
注意: このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/account/{accountUID} |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200 |
説明:
accountUIDは、アカウントの一意識別子です。
このAPIを使用して、アカウントに対するアクセス権をユーザーまたはロールに付与します。複数のユーザーおよびロールに同時にアクセス権を付与できます。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/account/{accountUID} |
メソッド |
|
Content-Type |
application/json |
本体 |
権限受領者の追加のJSON表現 |
成功時の戻り値 |
ステータス・コード200 |
例B-25 権限受領者の追加のサンプルJSON表現
{ "modifications":[ { "modification":{ "usagepolicy":"usagepolicy1", "role":"opamgroup1", "operation":"add" } }, { "modification":{ "usagepolicy":"usagepolicy1", "user":"opamuser1", "operation":"add" } } ] }
説明:
accountUIDは、アカウントの一意識別子です。
modificationsは、変更JSONオブジェクトの配列です。
modificationは、単一属性の変更を表すJSONオブジェクトです。
roleは、グループにアクセス権を付与する必要があることを示します。このパラメータの値は、グループ名です。
userは、ユーザーにアクセス権を付与する必要があることを示します。このパラメータの値は、ユーザー・ログインIDです。
usagepolicyは、権限付与に適用される使用ポリシーの識別子を示します。
operationは、実行される操作のタイプを示します。有効な値は次のとおりです。
addは権限付与を示します。
deleteは取消しを示します。
replaceは使用ポリシーの新しい値による置換を示します。
このAPIを使用して、アカウントに対するユーザーのアクセス権またはロールのアクセス権を削除します。複数のユーザーおよびロールの権限付与を同時に取り消すことができます。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/account/{accountUID} |
メソッド |
|
Content-Type |
application/json |
本体 |
権限受領者の削除のJSON表現 |
成功時の戻り値 |
ステータス・コード200 |
例B-26 権限受領者の削除のサンプル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は使用ポリシーの新しい値による置換を示します。
このAPIを使用して、CSFマップとキーをアカウントに追加したり、アカウントから削除します。複数のマップとキーを同時に追加または削除できます。
注意: このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/account/{accountUID} |
メソッド |
|
Content-Type |
application/json |
本体 |
キーマップの追加のJSON表現 |
成功時の戻り値 |
ステータス・コード200 |
例B-27 マップとキーの追加/削除のサンプルJSON表現
{ "modifications": [ { "modification": { "keymap": "[app1][sd45kjlf4g][t3://alc03qvb:7001][weblogic][password]", "operation": "add" } }, { "modification": { "keymap": "[hrmap][hrkey2][t3://asd01fgn:7001][weblogic][password]", "operation": "delete" } } ] }
説明:
accountUIDは、アカウントの一意識別子です。
modificationsは、変更JSONオブジェクトの配列です。
modificationは、単一属性の変更を表すJSONオブジェクトです。
keymapは、追加または削除するマップとキーです。マップとキーは、次の形式にする必要があります。
[csfmap][csfkey][Administration Server Url][username][password]
operationは、実行される操作のタイプを示します。有効な値は次のとおりです。
addは、マップとキーの追加を示します。
deleteは、マップとキーの削除を示します。
このAPIを使用して、アカウントのすべての権限受領者を取得します。権限受領者は、ユーザーまたはロールです。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロールまたはセキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/account/{accountUID}/grantees |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200および権限受領者のJSON表現 |
説明:
granteesは、アカウントの権限受領者です。
usersは、アカウントを付与されたユーザーです。各値は、ユーザーのログインID/UIDです。
rolesは、アカウントを付与されたグループまたはロールです。各値はグループ名です。
URI |
https://opam_server_host:opam_ssl_port/opam/account/{accountUID}/checkout |
メソッド |
|
Content-Type |
application/json |
本体 |
|
成功時の戻り値 |
ステータス・コード200およびアカウント・トークンのJSON表現 |
例B-29 アカウント・トークンのサンプルJSON表現
{ "accountToken":{ "accountName":"admin", "accountUID":"3f74a85e39e64432ba917a2e60fa15aa", "accountPassword":"GJN8p2ol" } }
説明:
accountUIDは、アカウントの一意識別子です。
accountNameは、アカウントの名前です。
accountpasswordは、アカウント・パスワードです。
注意: 強制的チェックインを実行するには、「ユーザー・マネージャ」管理ロールを持管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/account/{accountUID}/checkin |
メソッド |
|
Content-Type |
application/json |
本体 |
|
成功時の戻り値 |
ステータス・コード200 |
説明:
forceは、強制的チェックインを示すフラグです。(デフォルトはfalse
です。)
useridは、強制的にチェックインされるユーザーです。(デフォルトでは、強制的チェックインは、アカウントからチェックアウトしているすべてのユーザーに対して実行されます。)
このAPIを使用して、現在アカウントをチェックアウトしているすべてのユーザーのリストを取得します。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロールまたはセキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/account/{accountUID}/whocheckedout |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200およびアカウントをチェックアウトしたユーザーのJSON表現 |
例B-31 アカウントをチェックアウトしたユーザーのサンプルJSON表現
{ "users":[ { "user":{ "uid":"sec_admin", "expiryTime":1338765551, "checkoutTime":1338333551, } } ] }
説明:
uidは、ユーザーの一意識別子です。
expiryTimeは、チェックアウト・セッションの有効期限時刻です。このパラメータの値は、UNIX時間です。
checkoutTimeは、アカウントがチェックアウトされた時刻です。このパラメータの値は、UNIX時間です。
このAPIを使用して、アカウントに関連付けられたパスワードを取得および表示します。
注意: このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者であるか、アカウントからチェックアウトしている必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/account/{accountUID}/showpassword |
メソッド |
|
Content-Type |
application/json |
本体 |
|
成功時の戻り値 |
ステータス・コード200およびアカウント・トークンのJSON表現 |
例B-32 アカウント・トークンのサンプルJSON表現
{ "accountToken":{ "accountName":"admin", "accountUID":"3f74a85e39e64432ba917a2e60fa15aa", "accountPassword":"GJN8p2ol" } }
説明:
accountUIDは、アカウントの一意識別子です。
accountNameは、アカウントの名前です。
accountPasswordは、アカウント・パスワードです。
このAPIを使用して、アカウントに関連付けられているパスワード履歴を取得および表示します。
注意: このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者であるか、アカウントからチェックアウトしている必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/account/{accountUID}/showpasswordhistory |
メソッド |
|
Content-Type |
application/json |
本体 |
|
成功時の戻り値 |
ステータス・コード200およびアカウント・トークンのJSON表現 |
例B-33 アカウント・トークンのサンプルJSON表現
{ "accountToken":{ "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は、パスワードが変更された時間です。
この項では次のAPIについて説明します。
このAPIでは、次の検索リクエスト・パラメータを1つ以上使用してアカウントを検索します。
type
domain
description
name
accountname
これらのパラメータはすべてオプションです。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロールまたはセキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/ui/allaccounts/search?param1=val1¶m2=val2 |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200およびアカウント収集のJSON表現 |
例B-34 アカウント収集のサンプルJSON表現
{ "AccountCollection" : [ { "account" : { "shared" : false, "targetUID" : "eadd96486e9a47b79bd23cf1167bd2b2", "domain" : "needtofix", "targetName" : "sunds_6.3_target", "targetType" : "ldap", "accountlevelstatus" : "checkedIn", "description" : "", "accountName" : "dsperson1", "uri" : "https://slc03jfo:7002/opam/account/35e2709edf0443edae8f67727d937bec", "accountUID" : "35e2709edf0443edae8f67727d937bec" } }, { "account" : { "shared" : false, "targetUID" : "eadd96486e9a47b79bd23cf1167bd2b2", "domain" : "needtofix", "targetName" : "sunds_6.3_target", "targetType" : "ldap", "accountlevelstatus" : "checkedIn", "description" : "", "accountName" : "dsperson10", "uri" : "https://slc03jfo:7002/opam/account/0a1ee2cb17e345cdb537a2f05e11e93c", "accountUID" : "0a1ee2cb17e345cdb537a2f05e11e93c" } } ], "count" : 2 }
属性定義の詳細はすべて、B.3項「ターゲット・リソース」およびB.4項「アカウント・リソース」を参照してください。
このAPIを使用して割当て済アカウントを検索します。その際は、次の検索リクエスト・パラメータを1つ以上使用します。
type
domain
description
name
accountname
これらのパラメータはすべてオプションです。
URI |
https://opam_server_host:opam_ssl_port/opam/ui/myaccounts/search?param1= |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200およびアカウント収集のJSON表現 |
例B-35 アカウント収集のサンプルJSON表現
{ "AccountCollection" : [ { "account" : { "status" : "checkedIn", "shared" : false, "targetUID" : "b7af920f673149f5b0f66da28fdf8253", "domain" : "needtofix", "targetName" : "ldap_target", "targetType" : "ldap", "accountlevelstatus" : "checkedIn", "description" : "", "accountName" : "person1", "uri" : "https://slc03jfo:7002/opam/account/0d755f646bcf4fa08ca515ed3829aadf", "accountUID" : "0d755f646bcf4fa08ca515ed3829aadf" } }, { "account" : { "status" : "checkedIn", "shared" : false, "targetUID" : "b7af920f673149f5b0f66da28fdf8253", "domain" : "needtofix", "targetName" : "ldap_target", "targetType" : "ldap", "accountlevelstatus" : "checkedIn", "description" : "", "accountName" : "person2", "uri" : "https://slc03jfo:7002/opam/account/62c684c3821f4e118790e815ee881e02", "accountUID" : "62c684c3821f4e118790e815ee881e02" } } ], "count" : 2 }
説明:
statusは、リクエスト元ユーザーがアカウントからチェックアウトしているのかどうかを示します。
他のすべての属性定義の詳細は、B.3項「ターゲット・リソース」およびB.4項「アカウント・リソース」を参照してください。
このAPIを使用して、ログイン・ユーザーによってチェックアウトされたすべてのアカウントのリストを取得します。
URI |
https://opam_server_host:opam_ssl_port/ui/allaccounts/mycheckedout |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200およびアカウント収集のJSON表現 |
例B-36 アカウント収集のサンプルJSON表現
{ "AccountCollection":[ { "account":{ "uri":"https:\/\/opam_server_host:opam_ssl_port\/opam\/account\
/3740553e999a4f6aa8e8f9286d320cb4", "accountUID":"3740553e999a4f6aa8e8f9286d320cb4", "accountName":"sherlock", "status":"checkedOut", "targetUID":"9bbcbbb087174ad1900ea691a2573b61", "targetName":"person1-ldap", "targetType":"ldap", "domain":"berkeley", "expiryTime":1338765551, }, "count":1 } ] }
属性定義の詳細は、B.3項「ターゲット・リソース」およびB.4項「アカウント・リソース」を参照してください。
この項では次のAPIについて説明します。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロールまたはセキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/user/{uid} |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200およびユーザーのJSON表現 |
例B-37 ユーザーのサンプル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は、ユーザーの管理ロールです。
このAPIを使用して、ユーザーに付与されているすべてのアカウントを取得します。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロールまたはセキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/user/{uid}/accounts |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200およびアカウント収集のJSON表現 |
例B-38 アカウント収集のサンプルJSON表現
{ "accounts":[ { "account":{ "accountUID":"16d245784350469cbe25229a7c45af22", "accountName":"oidperson10", "targetID":"75a23e9f30ba456b961a1f5d327e67ef", "targetName":"ldap_target", "targetDomain":"needtofix", "targetType":"ldap" } }, { "account":{ "accountUID":"47671a7a4ebc44c496888aac5423dad1", "accountName":"oudperson11", "targetID":"488d6d656b2c4b96a5fd835c131b4c00", "targetName":"oud_11.115_target", "targetDomain":"needtofix", "targetType":"ldap" } } ] }
属性定義の詳細は、B.3項「ターゲット・リソース」およびB.4項「アカウント・リソース」を参照してください。
このAPIを使用してユーザーを検索します。このAPIでは、ユーザーのfirstname、lastname、uidおよびmailに対してsearchKeyWord
を検索します。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/user/search/{searchKeyWord} |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス200およびユーザーのJSON表現 |
例B-39 ユーザーのサンプル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.6.1項「ユーザーの取得」を参照してください。
このAPIを使用してユーザーを検索します。このAPIは、uidパラメータを使用した検索を含みます。
uidパラメータはオプションです。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/user/advancedsearch?param1=val1¶m2=val2 |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス200およびユーザーのJSON表現 |
例B-40 ユーザーのサンプル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.6.1項「ユーザーの取得」を参照してください。
この項では次のAPIについて説明します。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/group/{name} |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200およびグループのJSON表現 |
例B-41 グループのサンプルJSON表現
{ "group":{ "name":"opamgroup1", "dn":"cn=opamgroup1,ou=groups,ou=myrealm,dc=base_domain", "description":"", } }
説明:
nameは、グループの名前です。
dnは、グループの識別名です。
descriptionは、グループの説明です。
このAPIを使用してグループのユーザー・メンバーを取得します。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/group/{name}/users |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200およびユーザー収集のJSON表現 |
例B-42 ユーザー収集のサンプル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.6.1項「ユーザーの取得」を参照してください。
このAPIを使用してグループのグループ・メンバーを取得します。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/group/{name}/groups |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200およびグループ収集のJSON表現 |
例B-43 グループ収集のサンプル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.7.1項「グループの取得」を参照してください。
このAPIを使用して、グループに付与されているすべてのアカウントを取得します。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/group/{name}/accounts |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200およびアカウント収集のJSON表現 |
例B-44 アカウント収集のサンプルJSON表現
{ "accounts":[ { "account":{ "accountUID":"16d245784350469cbe25229a7c45af22", "accountName":"oidperson10", "targetID":"75a23e9f30ba456b961a1f5d327e67ef", "targetName":"ldap_target", "targetDomain":"needtofix", "targetType":"ldap" } }, { "account":{ "accountUID":"47671a7a4ebc44c496888aac5423dad1", "accountName":"oudperson11", "targetID":"488d6d656b2c4b96a5fd835c131b4c00", "targetName":"oud_11.115_target", "targetDomain":"needtofix", "targetType":"ldap" } } ] }
属性定義の詳細は、B.3項「ターゲット・リソース」およびB.4項「アカウント・リソース」を参照してください。
このAPIを使用してグループを検索します。このAPIでは、グループ名に対してsearchKeyWord
を検索します。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/group/search/{searchKeyWord} |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス200およびグループのJSON表現 |
例B-45 グループのサンプル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.7.1項「グループの取得」を参照してください。
このAPIを使用してアカウントに割り当てられているグループを検索します。リクエスト・パラメータはgroupname
です。これはオプションです。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/group/advancedsearch?param1=val1¶m2=val2 |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス200およびグループのJSON表現 |
例B-46 グループのサンプル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.7.1項「グループの取得」を参照してください。
この項では次のAPIについて説明します。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロールまたはセキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/usagepolicy |
メソッド |
|
Content-Type |
application/json |
本体 |
使用ポリシーの作成のJSON表現 |
成功時の戻り値 |
ステータス・コード201 |
例B-47 使用ポリシーの作成のサンプルJSON表現
{ "usagepolicy":{ "policystatus":"active", "policyname":"Default Usage Policy", "description":"Default Usage Policy", "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" } ] } }
属性定義の詳細は、B8.2項「使用ポリシーの取得」を参照してください。
URI |
https://opam_server_host:opam_ssl_port/opam/usagepolicy/{policyid} |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200および使用ポリシーのJSON表現 |
例B-48 使用ポリシーのサンプル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" } ], } }
説明:
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の整数値です。
tominutesは、0から60の整数値です。
toamorpmは、amまたはpmです。
このAPIを使用して、使用ポリシーの権限付与のリストを取得します。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロールまたはセキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/usagepolicy/{policyid}/grantees |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200および権限のJSON表現 |
例B-49 権限のサンプルJSON表現
{ "grantees":[ { "grantee":{ "accountUID":"16d245784350469cbe25229a7c45af22", "accountName":"oidperson10", "targetID":"75a23e9f30ba456b961a1f5d327e67ef", "targetName":"ldap_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.3項「ターゲット・リソース」およびB.4項「アカウント・リソース」を参照してください。
このAPIを使用して使用ポリシーを更新します。policyid
を除くすべての属性の更新が可能で、同時に複数の属性を更新できます。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロールまたはセキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/usagepolicy/{policyid} |
メソッド |
|
Content-Type |
application/json |
本体 |
使用ポリシーの変更のJSON表現 |
成功時の戻り値 |
ステータス・コード200 |
例B-50 使用ポリシーの変更のサンプル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 } } ] }
説明:
modificationsは、変更JSONオブジェクトの配列です。
modificationは、単一属性を表すJSONオブジェクトです。
ターゲットのusagedates
およびexpireddatehour
属性を更新する必要があります。これらの値は、指定された値に更新されます。
この項では次のAPIについて説明します。
注意: このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/passwordpolicy |
メソッド |
|
Content-Type |
application/json |
本体 |
パスワード・ポリシーの作成のJSON表現 |
成功時の戻り値 |
ステータス・コード201 |
例B-51 パスワード・ポリシーの作成のサンプルJSON表現
{ "passwordpolicy":{ "policystatus":"active", "policyname":"Default 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です。属性定義の詳細は、B9.2項「パスワード・ポリシーの取得」を参照してください。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロールまたはセキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/passwordpolicy/{policyid} |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200およびパスワード・ポリシーのJSON表現 |
例B-52 パスワード・ポリシーのサンプル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は、パスワードに使用できる繰返し文字の最大数です。
このAPIを使用してパスワード・ポリシーのアカウント・リストを取得します。
注意: このAPIを使用するには、「ユーザー・マネージャ」管理ロールまたはセキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/passwordpolicy/{policyid}/accounts |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200およびアカウントのJSON表現 |
例B-53 アカウントのサンプル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":"ldap_target", "targetDomain":"needtofix", "targetType":"ldap" } } } ] }
属性定義の詳細は、B.3項「ターゲット・リソース」およびB.4項「アカウント・リソース」を参照してください。
注意: このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/passwordpolicy/{policyid} |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス200 |
このAPIを使用して使用ポリシーを更新します。policyid
を除くすべての属性の更新が可能で、同時に複数の属性を更新できます。
注意: このAPIを使用するには、セキュリティ管理者管理ロールを持つ管理者である必要があります。 |
URI |
https://opam_server_host:opam_ssl_port/opam/passwordpolicy/{policyid} |
メソッド |
|
Content-Type |
application/json |
本体 |
パスワード・ポリシーの変更のJSON表現 |
成功時の戻り値 |
ステータス・コード200 |
例B-54 パスワード・ポリシーの変更のサンプルJSON表現
{ "modifications":[ { "modification":{ "disalloweddchars":[ "4", "6" ] } }, { "modification":{ "passwordalphabeticmin":2 } } ] }
説明:
modificationsは、変更JSONオブジェクトの配列です。
modificationは、単一属性を表すJSONオブジェクトです。
この項では次のAPIについて説明します。
このAPIを使用してアカウントを検索します。このAPIは、次のパラメータを1つ以上使用したcontains条件検索です。
policystatus
policyname
パラメータはすべてオプションです。
URI |
https://opam_server_host:opam_ssl_port/opam/policy/search?param1=val1¶m2=val2 |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200およびポリシーのJSON表現 |
例B-55 ポリシーのサンプル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
です。
このAPIを使用して、デフォルト使用ポリシーおよびデフォルト・パスワード・ポリシーを取得します。
URI |
https://opam_server_host:opam_ssl_port/opam/policy/default |
メソッド |
|
Content-Type |
|
本体 |
|
成功時の戻り値 |
ステータス・コード200およびポリシーのJSON表現 |
例B-56 ポリシーのサンプル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
です。
この属性は、デフォルト・ポリシー(デフォルト使用ポリシーおよびデフォルト・パスワード・ポリシー)のみを返します。