3.2 拡張設定パラメータ

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

注意:

  • 指定がないかぎり、次の表のエントリは変更しないでください。

  • 次の表のパラメータはすべて必須です。

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

   
Bundle Name

このエントリは、コネクタ・バンドルの名前を保持します。

デフォルト値:

org.identityconnectors.genericrest
Bundle Version

このエントリは、コネクタ・バンドルのバージョンを保持します。

デフォルト値: 12.3.0

Connector Name

このエントリには、コネクタ・クラスの名前が保持されます。

デフォルト値:

org.identityconnectors.genericrest.GenericRESTConnector
relURIs

このエントリは、このコネクタでサポートされている各オブジェクト・クラスの相対URLおよびこれらのオブジェクト・クラスで実行可能なコネクタ操作を含みます。これは、アプリケーションを作成する際の必須属性です。

デフォルト値:
"__ACCOUNT__.CREATEOP=/$(api_version)$/users","__ACCOUNT__.UPDATEOP=/$(api_version)$/users/$(__UID__)$","__ACCOUNT__.DELETEOP=/$(api_version)$/users/$(__UID__)$?action=delete","__ACCOUNT__.__PASSWORD__.UPDATEOP=/$(api_version)$/users/$(__UID__)$/password","__ACCOUNT__.SEARCHOP=/$(api_version)$/users?$(Filter Suffix)$&page_size=$(PAGE_SIZE)$&next_page_token=$(PAGE_TOKEN)$","__GROUP__.SEARCHOP=/$(api_version)$/groups","__ACCOUNT__.group_ids.SEARCHOP=/$(api_version)$/users/$(__UID__)$","__ACCOUNT__.group_ids.UPDATEOP=/$(api_version)$/groups/$(group_ids)$/members","__ACCOUNT__.group_ids.DELETEOP=/$(api_version)$/groups/$(group_ids)$/members/$(__UID__)$","__ROLE__.SEARCHOP=/$(api_version)$/roles","__ACCOUNT__.role_id.UPDATEOP=/$(api_version)$/roles/$(role_id)$/members","__ACCOUNT__.role_id.DELETEOP=/$(api_version)$/roles/$(role_id)$/members/$(__UID__)$","__ACCOUNT__.__ENABLE__.UPDATEOP=/$(api_version)$/users/$(__UID__)$/status","__ACCOUNT__.__NAME__.UPDATEOP=/$(api_version)$/users/$(__UID__)$/email"
nameAttributes

このエントリは、このコネクタにより処理されるすべてのオブジェクトの名前属性を含みます。

たとえば、ユーザー・アカウントに使用される__ACCOUNT__オブジェクト・クラスの名前属性はuserPrincipalNameです。

デフォルト値

"__ACCOUNT__.email","__GROUP__.name","__ROLE__.name"
uidAttributes

このエントリは、このコネクタにより処理されるすべてのオブジェクトのuid属性を含みます。

たとえば、ユーザー・アカウントのuid属性はobjectIdです。

言い換えると、デコードの値__ACCOUNT__objectIdは、_ACCOUNT__オブジェクト・クラスのコネクタの__UID__属性(つまりGUID)が、ターゲット・システムのユーザー・アカウントの対応するuid属性であるobjectIdにマッピングされるということです。

デフォルト値:

"__ACCOUNT__.id","__GROUP__.id","__ROLE__.id"
opTypes

このエントリは、コネクタでサポートされる各オブジェクト・クラスのHTTP操作タイプを指定します。値はカンマ区切りで、次の形式です: OBJ_CLASS.OP=HTTP_OP

この形式において、OBJ_CLASSはコネクタ・オブジェクト・クラス、OPはコネクタ操作(CreateOp、UpdateOp、SearchOpなど)およびHTTP_OPはHTTP操作(GET、PUTまたはPOST)です。

デフォルト値:

"__ACCOUNT__.CREATEOP=POST","__ACCOUNT__.UPDATEOP=PATCH","__ACCOUNT__.SEARCHOP=GET","__ACCOUNT__.TESTOP=GET","__ACCOUNT__.group_ids.UPDATEOP=POST","__ACCOUNT__.role_id.UPDATEOP=POST","__ACCOUNT__.__PASSWORD__.UPDATEOP=PUT","__ACCOUNT__.__ENABLE__.UPDATEOP=PUT","__ACCOUNT__.__NAME__.UPDATEOP=PUT"
pageSize

検索操作に対して1ページに表示されるリソースおよびユーザーの数。

デフォルト値:

30

pageTokenAttribute

次のページ・トークンを示すレスポンス・ペイロード内の属性。

デフォルト値:

next_page_token
jsonResourcesTag

このエントリは、リコンシリエーション中に単一ペイロード内の複数のエントリの解析のために使用されるjsonタグ値を含みます。

デフォルト値:

"__ACCOUNT__=users","__GROUP__=groups","__ROLE__=roles"
httpHeaderContentType

このエントリは、ヘッダーの、ターゲット・システムが予期するコンテンツ・タイプを含みます。

デフォルト値:

application/json
httpHeaderAccept

このエントリは、ヘッダーの、ターゲット・システムに対して期待する受入タイプを含みます。

デフォルト値:

application/json
provisionDisableValue

この値は、プロビジョニングによってユーザーを非アクティブ化するために使用されます。

デフォルト値:

deactivate
provisionEnableValue

この値は、プロビジョニングによってユーザーをアクティブ化するために使用されます。

デフォルト値:
activate
statusDisableValue

この値は、リコンシリエーション中にユーザーを非アクティブ化するために使用されます。

デフォルト値:
inactive
statusEnableValue

この値は、リコンシリエーション中にユーザーをアクティブ化するために使用されます。

デフォルト値:
active
specialAttributeTargetFormat

このエントリには、属性がターゲット・システム・エンドポイントに存在する形式がリストされます。

たとえば、ターゲット・システム・エンドポイントにおいて別名属性はaliases.aliasとして存在します。値はカンマ区切りで、次の形式で示されます: OBJ_CLASS.ATTR_NAME= TARGET_FORMAT

デフォルト値:
"__ACCOUNT__.group_ids=group_ids","__ACCOUNT__.role_id=value"
specialAttributeHandling

このエントリには、値をターゲット・システムに1つずつ("SINGLE")送信する必要がある特殊属性がリストされます。値はカンマ区切りで、次の形式です:

OBJ_CLASS.ATTR_NAME.PROV_OP=SINGLE

たとえば、デコードの値が__ACCOUNT__.manager.UPDATEOP=SINGLEである場合は、更新プロビジョニング操作中に__ACCOUNT__オブジェクト・クラスのmanager属性がターゲット・システムに1つずつ送信される必要があることを示します。

デフォルト値:
"__ACCOUNT__.group_ids.CREATEOP=SINGLE","__ACCOUNT__.group_ids.UPDATEOP=SINGLE","__ACCOUNT__.role_id.CREATEOP=SINGLE","__ACCOUNT__.role_id.UPDATEOP=SINGLE"
customPayload

このエントリは、標準の形式ではないすべての操作のペイロードを示します。

デフォルト値:
"__ACCOUNT__.CREATEOP={\"action\": \"$(createType)$\",\"user_info\": { \"email\": \"$(__NAME__)$\",\"type\": \"$(type)$\",\"first_name\": \"$(first_name)$\",\"last_name\": \"$(last_name)$\",\"password\": \"$(__PASSWORD__)$\"}}","__ACCOUNT__.group_ids.UPDATEOP={\"members\": [{ \"id\": \"$(__UID__)$\"}]}","__ACCOUNT__.role_id.UPDATEOP={\"members\": [{\"id\": \"$(__UID__)$\"}]}","__ACCOUNT__.__ENABLE__.UPDATEOP={\"action\": \"$(__ENABLE__)$\"}","__ACCOUNT__.__NAME__.UPDATEOP={\"email\": \"$(__NAME__)$\"}"
statusAttributes

このエントリには、アカウントのステータスを含むターゲット・システム属性の名前がリストされます。たとえば、ユーザー・アカウントに使用される__ACCOUNT__オブジェクト・クラスのステータス属性は"status"です。

デフォルト値:
"__ACCOUNT__.status"
passwordAttribute

このエントリは、OIMのコネクタの__PASSWORD__属性にマッピングされるターゲット・システム属性の名前を含みます。

デフォルト値:
password
childFieldsWithSingleEndpoint

このエントリは、単一のエンドポイント・レスポンスからの特別な属性データを指定します

デフォルト値:
"__GROUP__","__ROLE__"