拡張設定パラメータ

前次このコンテンツを正しく表示するにはJavaScriptが有効になっている必要があります

3.2 拡張設定パラメータ

これらは、リコンシリエーション操作およびプロビジョニング操作時にコネクタが使用する構成関連エントリです。

ノート:

指定がないかぎり、次の表のエントリは変更しないでください。
次の表のパラメータはすべて必須です。

表3-2 拡張設定パラメータ

パラメータ	必須?	説明
Connector Name	はい	このエントリには、コネクタ・クラスの名前が保持されます。デフォルト値: org.identityconnectors.genericrest.GenericRESTConnector
Bundle Name	はい	このエントリは、コネクタ・バンドルの名前を保持します。デフォルト値: org.identityconnectors.genericrest
Bundle Version	はい	このエントリは、コネクタ・バンドルのバージョンを保持します。デフォルト値: 12.3.0
nameAttributes	はい	このエントリは、このコネクタにより処理されるすべてのオブジェクトのnamehelpText="Target属性を含みます。たとえば、ユーザー・アカウントに使用される__ACCOUNT__各オブジェクト・クラスの__NAME__の名前属性はuser_nameです。デフォルト値: "GroupID.groupName","__ACCOUNT__.userName","RoleId.RoleName","LobId.lobName","__DOMAIN__.SadDomainName","__USERTYPE__.UserTypeName","UserDualAuthFactType.DualFactorType","__USERSERVICE__.ServiceTypeName","__ONETIMEUSERSERVICE__.ServiceTypeName","__TIMEBASEDUSERSERVICE__.ServiceTypeName","__ACCESSTYPE__.AccessTypeName"
uidAttributes	はい	このエントリは、このコネクタにより処理されるすべてのオブジェクトのuidhelpText="Target属性を含みます。たとえば、各オブジェクト・クラスの__UID__です。デフォルト値: "GroupID.id","__DOMAIN__.SadDomainName","LobId.id","RoleId.RoleId","__ACCOUNT__.id","UserDualAuthFactType.id","__USERTYPE__.UserTypeId","__USERSERVICE__.ServiceId","__ONETIMEUSERSERVICE__.ServiceId","__TIMEBASEDUSERSERVICE__.ServiceId","__ACCESSTYPE__.AccessTypeId"
relURIs	はい	このエントリは、このコネクタでサポートされている各オブジェクト・クラスの相対URLおよびこれらのオブジェクト・クラスで実行可能なコネクタ操作を含みます。デフォルト値: "LobId.SEARCHOP=/$(api_version)$/Lobs","__ACCOUNT__.LobId.ADDATTRIBUTE=/$(api_version)$/Lobs","__ACCOUNT__.LobId.REMOVEATTRIBUTE=/$(api_version)$/Lobs","__ACCOUNT__.SEARCHOP=/$(api_version)$/Users$(Filter Suffix)$?LobId=All Lobs&PageNumber=$(PAGE_INCREMENT)$&PageSize=$(PAGE_SIZE)$","__ACCOUNT__.TESTOP=/$(api_version)$/UserType","__ACCOUNT__.CREATEOP=/$(api_version)$/Users","__ACCOUNT__.UPDATEOP=/$(api_version)$/Users/$(__UID__)$","__ACCOUNT__.DELETEOP=/$(api_version)$/Users/$(__UID__)$","GroupID.SEARCHOP=/$(api_version)$/Groups?LobId=All Lobs&IsFullRecords=1","__ACCOUNT__.GroupID.ADDATTRIBUTE=/$(api_version)$/Groups","__ACCOUNT__.GroupID.REMOVEATTRIBUTE=/$(api_version)$/Groups","__USERSERVICE__.SEARCHOP=/$(api_version)$/Services?LobId=All Lobs&IsFullRecords=1","__ACCOUNT__.__USERSERVICE__.ADDATTRIBUTE=/$(api_version)$/Services","__ACCOUNT__.__USERSERVICE__.REMOVEATTRIBUTE=/$(api_version)$/Services","__ACCOUNT__.__ONETIMEUSERSERVICE__.ADDATTRIBUTE=/$(api_version)$/Services","__ACCOUNT__.__TIMEBASEDUSERSERVICE__.ADDATTRIBUTE=/$(api_version)$/Services","RoleId.SEARCHOP=/$(api_version)$/Role?LobId=All Lobs","__ACCOUNT__.RoleId.ADDATTRIBUTE=/$(api_version)$/Role","__ACCOUNT__.RoleId.REMOVEATTRIBUTE=/$(api_version)$/Role","__DOMAIN__.SEARCHOP=/$(api_version)$/Domain","__USERTYPE__.SEARCHOP=/$(api_version)$/UserType","UserDualAuthFactType.SEARCHOP=/$(api_version)$/DualAuth","__ACCOUNT__.ENABLEOP=/$(api_version)$/Users/$(__UID__)$","__ACCOUNT__.DISABLEOP=/$(api_version)$/Users/$(__UID__)$","__ACCOUNT__.__PASSWORD__.UPDATEOP=/$(api_version)$/Users/$(__UID__)$","__ACCOUNT__.UserDualAuthFactType.ADDATTRIBUTE=/$(api_version)$/DualAuth","__ACCOUNT__.UserDualAuthFactType.REMOVEATTRIBUTE=/$(api_version)$/DualAuth","__ACCESSTYPE__.SEARCHOP=/$(api_version)$/Services/GetAccessTypes"
opTypes	いいえ	このエントリは、コネクタでサポートされる各オブジェクト・クラスのHTTP操作タイプを指定します。値はカンマ区切りで、次の形式です: OBJ_CLASS.OP=HTTP_OP この形式において、OBJ_CLASSはコネクタ・オブジェクト・クラス、OPはコネクタ操作(CreateOp、UpdateOp、SearchOpなど)、およびHTTP_OPはHTTP操作(GET、PUTまたはPOST)です。デフォルト値: "LobId.SEARCHOP=GET","__ACCOUNT__.LobId.ADDATTRIBUTE=PATCH","__ACCOUNT__.LobId.REMOVEATTRIBUTE=PATCH","__ACCOUNT__.SEARCHOP=GET","__ACCOUNT__.CREATEOP=POST","__ACCOUNT__.UPDATEOP=PUT","__ACCOUNT__.DELETEOP=DELETE","GroupID.SEARCHOP=GET","__ACCOUNT__.GroupID.ADDATTRIBUTE=PATCH","__ACCOUNT__.GroupID.REMOVEATTRIBUTE=PATCH","__ACCOUNT__.__USERSERVICE__.SEARCHOP=GET","__ACCOUNT__.__USERSERVICE__.ADDATTRIBUTE=PATCH","__ACCOUNT__.__USERSERVICE__.REMOVEATTRIBUTE=PATCH","__ACCOUNT__.__ONETIMEUSERSERVICE__.ADDATTRIBUTE=PATCH","__ACCOUNT__.__TIMEBASEDUSERSERVICE__.ADDATTRIBUTE=PATCH","RoleId.SEARCHOP=GET","__ACCOUNT__.RoleId.ADDATTRIBUTE=PATCH","__ACCOUNT__.RoleId.REMOVEATTRIBUTE=PATCH","__DOMAIN__.SEARCHOP=GET","__USERTYPE__.SEARCHOP=GET","UserDualAuthFactType.SEARCHOP=GET","__ACCOUNT__.TESTOP=GET","__ACCOUNT__.ENABLEOP=PUT","__ACCOUNT__.DISABLEOP=PUT","__ACCOUNT__.__PASSWORD__.UPDATEOP=PUT","__ACCOUNT__.UserDualAuthFactType.ADDATTRIBUTE=PATCH","__ACCOUNT__.UserDualAuthFactType.REMOVEATTRIBUTE=PATCH"
pageSize	いいえ	検索操作に対して1ページに表示されるユーザーの数。デフォルト値: 100
statusEnableValue	いいえ	この値は、リコンシリエーション中にユーザーをアクティブ化するために使用されます。デフォルト値:1
statusDisableValue	いいえ	この値は、リコンシリエーション中にユーザーを非アクティブ化するために使用されます。デフォルト値:0
jsonResourcesTag	いいえ	このエントリは、リコンシリエーション中に単一ペイロード内の複数のエントリの解析のために使用されるjsonタグ値を含みます。デフォルト値: "GroupID=Result","__DOMAIN__=Result","LobId=Result","__ACCOUNT__=Result","RoleId=Result","UserDualAuthFactType=Result","__USERTYPE__=Result","__ACCESSTYPE__=Result","__USERSERVICE__=Result","__ONETIMEUSERSERVICE__=Result","__TIMEBASEDUSERSERVICE__=Result"
httpHeaderContentType	いいえ	このエントリは、ヘッダーの、ターゲット・システムが予期するコンテンツ・タイプを含みます。デフォルト値: application/json
httpHeaderAccept	いいえ	このエントリは、ヘッダーの、ターゲット・システムに対して期待する受入タイプを含みます。デフォルト値: application/json
specialAttributeHandling	いいえ	このエントリには、属性がターゲット・システム・エンドポイントに存在する形式がリストされます。値はカンマ区切りで、次の形式で示されます: OBJ_CLASS.ATTR_NAME= TARGET_FORMAT。デフォルト値: "__ACCOUNT__.GroupID.ADDATTRIBUTE=SINGLE","__ACCOUNT__.GroupID.REMOVEATTRIBUTE=SINGLE","__ACCOUNT__.RoleId.ADDATTRIBUTE=SINGLE","__ACCOUNT__.RoleId.REMOVEATTRIBUTE=SINGLE","__ACCOUNT__.LobId.ADDATTRIBUTE=SINGLE","__ACCOUNT__.LobId.REMOVEATTRIBUTE=SINGLE","__ACCOUNT__.__USERSERVICE__.ADDATTRIBUTE=SINGLE","__ACCOUNT__.__USERSERVICE__.REMOVEATTRIBUTE=SINGLE","__ACCOUNT__.UserDualAuthFactType.ADDATTRIBUTE=SINGLE","__ACCOUNT__.UserDualAuthFactType.REMOVEATTRIBUTE=SINGLE","__ACCOUNT__.__ONETIMEUSERSERVICE__.ADDATTRIBUTE=SINGLE","__ACCOUNT__.__TIMEBASEDUSERSERVICE__.ADDATTRIBUTE=SINGLE"
customPayload	いいえ	このエントリは、標準の形式ではないすべての操作のペイロードを示します。デフォルト値: "__ACCOUNT__.ENABLEOP={\"ValidTillDate\":\"12/31/2058 12:00:00 AM\",\"IsActive\":1}","__ACCOUNT__.DISABLEOP={\"ValidTillDate\":\"12/31/2022 12:00:00 AM\",\"IsActive\":1}","__ACCOUNT__.__PASSWORD__.UPDATEOP={\"password\":\"$(__PASSWORD__)$\"}","__ACCOUNT__.GroupID.ADDATTRIBUTE={\"op\":\"add\",\"GroupID\":$(id)$,\"LobId\":\"All Lobs\",\"value\":[{\"UserId\":$(__UID__)$}]}","__ACCOUNT__.GroupID.REMOVEATTRIBUTE={\"op\":\"remove\",\"GroupID\":$(id)$,\"LobId\":\"All Lobs\",\"value\":[{\"UserId\":$(__UID__)$}]}","__ACCOUNT__.RoleId.ADDATTRIBUTE={\"op\":\"add\",\"UserId\":$(__UID__)$,\"RoleId\":[$(RoleId)$]}","__ACCOUNT__.RoleId.REMOVEATTRIBUTE={\"op\":\"remove\",\"UserId\":$(__UID__)$,\"RoleId\":[$(RoleId)$]}","__ACCOUNT__.CREATEOP={\"userName\":\"$(__NAME__)$\",\"displayName\":\"$(displayName)$\",\"ValidTillDate\":\"$(ValidTillDate)$\",\"IsActive\":1,\"emails\":{\"value\":\"$(emails.value)$\"},\"phoneNumbers\":{\"value\":\"$(phoneNumbers.value)$\"},\"GroupID\":[],\"domainName\":\"$(domainName)$\",\"LobId\":\"$(LobPrimary)$\",\"userTypeId\":$(userTypeId)$,\"password\":\"$(__PASSWORD__)$\",\"RoleId\":[4]}","__ACCOUNT__.LobId.ADDATTRIBUTE={\"op\":\"add\",\"UserID\":$(__UID__)$,\"LobId\":[$(LobId)$]}","__ACCOUNT__.LobId.REMOVEATTRIBUTE={\"op\":\"remove\",\"UserID\":$(__UID__)$,\"LobId\":[$(LobId)$]}","__ACCOUNT__.UserDualAuthFactType.ADDATTRIBUTE={\"op\": \"add\",\"UserId\": $(__UID__)$,\"DualFactorTypeId\": [$(id)$]}","__ACCOUNT__.UserDualAuthFactType.REMOVEATTRIBUTE={\"op\": \"remove\",\"UserId\": $(__UID__)$,\"DualFactorTypeId\": [$(id)$]}","__ACCOUNT__.__USERSERVICE__.ADDATTRIBUTE={\"op\":\"add\",\"UserID\":$(__UID__)$,\"LobId\":\"All Lobs\",\"value\":[{\"ServiceId\": $(ServiceId)$}]}","__ACCOUNT__.__USERSERVICE__.REMOVEATTRIBUTE={\"op\":\"remove\",\"UserID\":$(__UID__)$,\"LobId\":\"All Lobs\",\"value\":[{\"ServiceId\": $(ServiceId)$}]}","__ACCOUNT__.__ONETIMEUSERSERVICE__.ADDATTRIBUTE={\"op\":\"add\",\"UserID\":$(__UID__)$,\"LobId\":\"All Lobs\", \"AccessType\":\"$(AccessTypeId)$\",\"StartDateTime\":\"$(StartDateTime)$\",\"EndDateTime\":\"$(EndDateTime)$\",\"value\":[{\"ServiceId\":$(ServiceId)$}]}","__ACCOUNT__.__TIMEBASEDUSERSERVICE__.ADDATTRIBUTE={\"op\":\"add\",\"UserID\":$(__UID__)$,\"LobId\":\"All Lobs\",\"AccessType\":\"$(AccessTypeId)$\",\"StartDate\":\"$(StartDate)$\",\"EndDate\":\"$(EndDate)$\",\"StartTime\":\"$(StartTime)$\",\"EndTime\":\"$(EndTime)$\",\"hours\":\"$(hours)$\",\"minutes\":\"$(minutes)$\",\"value\":[{\"ServiceId\":$(ServiceId)$}]}" ノート: ValidTillDateは、カスタム・ペイロードのENABLEOPおよびDISABLEOP URLに対する顧客要件に従って指定できます
statusAttributes	いいえ	このエントリには、アカウントのステータスを含むターゲット・システム属性の名前がリストされます。たとえば、 `__ACCOUNT__` ユーザー・アカウントに使用されるオブジェクト・クラスの場合、ステータス属性は `accountEnabled` です。デフォルト値: __ACCOUNT__.IsActive
passwordAttribute	いいえ	このエントリは、OIMのコネクタの__PASSWORD__属性にマッピングされるターゲット・システム属性の名前を含みます。デフォルト値: password
targetObjectIdentifier	いいえ	このエントリは、relURIのプレースホルダを置き換えるキーと値のペアを指定します。値はカンマ区切りで、KEY;VALUEの形式です。デフォルト値: "__ACCOUNT__.__USERSERVICE__=AccessTypeId;1","__ACCOUNT__.__ONETIMEUSERSERVICE__=AccessTypeId;2","__ACCOUNT__.__TIMEBASEDUSERSERVICE__=AccessTypeId;3"
attrNameIdentifier	いいえ	このエントリは、jsonレスポンスのサービス情報を識別する変数を指定しますデフォルト値: "__USERSERVICE__=UserServicesId","__ONETIMEUSERSERVICE__=UserServicesId","__TIMEBASEDUSERSERVICE__=UserServicesId"