3 Boxコネクタの構成
アプリケーションの作成時には、コネクタがOracle Identity Governanceをターゲット・システムに接続し、コネクタ操作を実行するために使用する接続関連パラメータを構成する必要があります。また、Oracle Identity Governanceのプロセス・フォーム・フィールドとターゲット・システムの列の属性マッピング、事前定義済相関ルール、状況とレスポンスおよびリコンシリエーション・ジョブを表示して編集できます。
この項では、次の項目について説明します。
3.1 基本構成パラメータ
ここでは、Boxターゲット・アプリケーションへの接続にOracle Identity Governanceで必要となる接続関連のパラメータについて説明します。
ノート:
明記されていない場合、この表のパラメータはターゲット・アプリケーションと認可アプリケーションの両方に適用できます。表3-1 Boxコネクタの基本構成パラメータ
| パラメータ | 必須かどうか | 説明 |
|---|---|---|
|
authenticationType |
あり |
ターゲット・システムにより使用される認証のタイプを入力します。Boxターゲット・システムでは、OAuth2.0認証でアクセス・トークンとリフレッシュ・トークンの手動入力を使用します。 デフォルト値: Other |
|
Host |
あり |
ターゲット・システムをホストしているコンピュータのホスト名を入力します。 サンプル値: api.box.com/2.0 |
|
clientId |
あり |
登録処理中に認証サーバーによってクライアント・アプリケーションに対して発行されるクライアント識別子(一意の文字列)を入力します。新しく登録したアプリケーションを構成しているときにクライアントIDを取得しています。 サンプル値: 83b-88onw9ddvgy9nnbworruf0x4nre9 |
|
clientSecret |
あり |
クライアント・アプリケーションのアイデンティティを認証するのに使用されるシークレット・キーを入力します。このシークレット・キーは、新しく追加されたアプリケーションの構成の説明に示されている手順を実行するときに取得しました。 サンプル値: 5Zi1PivsZDd00iHwK1GcZmvv5qNFCvuI |
|
customAuthHeaders |
あり |
アクセス・トークンおよびリフレッシュ・トークンの値を取得します。
サンプル値: "access_token=fjvf0ghwpm3H1gSnWec3NcSVkgUFLIaQ","refresh_token=V1P163HMIC52RDxVE8rwlWHas0w71QWAJ2AXSivEpr6LluxGsQtDB34nxuKHhFJd"
|
|
sslEnabled |
あり |
ターゲット・システムでSSL接続が必要な場合、このパラメータの値をtrueに設定します。 そうではない場合、値をfalseに設定します。 デフォルト値 : |
|
コネクタ・サーバー名 |
いいえ |
Javaコネクタ・サーバーでBoxコネクタを使用している場合は、コネクタ・サーバーの名前を指定します。 |
|
Port |
いいえ |
ターゲット・システムがリスニングしているポート番号を入力します。 サンプル値: 443 |
|
proxyHost |
いいえ |
外部ターゲットへの接続に使用されるプロキシ・ホストの名前を入力します。 |
|
proxyPassword |
いいえ |
ターゲット・システムに接続するために、Oracle Identity Governanceにより使用されるターゲット・システム・ユーザー・アカウントのプロキシ・ユーザーIDのパスワード。 |
|
proxyPort |
いいえ |
プロキシ・ポート番号。 |
| proxyUser |
いいえ |
ターゲット・システムに接続するために、Oracle Identity Managerにより使用されるターゲット・システム・ユーザー・アカウントのプロキシ・ユーザー名。 |
3.2 拡張設定パラメータ
拡張設定パラメータは、リコンシリエーション操作およびプロビジョニング操作の際にコネクタで使用される構成関連のエントリです。
ノート:
次の表のすべてのパラメータは必須です表3-2 Boxコネクタの拡張設定パラメータ
| パラメータ | 説明 |
|---|---|
|
Bundle Name |
このエントリは、コネクタ・バンドルの名前を保持します。 デフォルト値: org.identityconnectors.genericrest |
|
Bundle Version |
このエントリは、コネクタ・バンドルのバージョンを保持します。 デフォルト値: 12.3.0 |
|
Connector Name |
このエントリは、コネクタの名前を含みます。 デフォルト値: org.identityconnectors.genericrest.GenericRESTConnector |
|
httpHeaderAccept |
このエントリは、ヘッダーの、ターゲット・システムに対して期待する受入タイプを含みます。 デフォルト値:application/json |
|
customPayload |
このエントリは、標準の形式ではないすべての操作のペイロードを示します。 デフォルト値:
|
|
nameAttributes |
このエントリは、このコネクタにより処理されるすべてのオブジェクトの名前属性を含みます。 デフォルト値: |
|
jsonResourcesTagspecialAttributeHandling |
このエントリは、リコンシリエーション中に単一ペイロード内の複数のエントリの解析のために使用されるjsonタグ値を含みます。 デフォルト値: |
|
specialAttributeHandling |
ターゲット・システムに1回に1つずつ個別のコールで送信する必要がある特殊属性のリストを入力します。このパラメータの値を指定しない場合、コネクタは、指定した特殊属性のすべての値を1回のコールで送信します。 デフォルト値:"__ACCOUNT__.__GROUP__.CREATEOP=SINGLE","__ACCOUNT__.__GROUP__.UPDATEOP=SINGLE","__ACCOUNT__.email.CREATEOP=SINGLE","__ACCOUNT__.email.UPDATEOP=SINGLE","__ACCOUNT__.role.SEARCHOP=SINGLE","__ACCOUNT__.is_exempt_from_login_verification.SEARCHOP=SINGLE","__ACCOUNT__.is_sync_enabled.SEARCHOP=SINGLE" |
|
httpHeaderContentType |
このエントリは、ヘッダーの、ターゲット・システムに対して期待するコンテンツ・タイプを含みます。 デフォルト値: |
|
relURIs (Box) |
このエントリは、このコネクタでサポートされている各オブジェクト・クラスの相対URLおよびこれらのオブジェクト・クラスで実行可能なコネクタ操作を含みます。 デフォルト値:"__ACCOUNT__.CREATEOP=/users","__ACCOUNT__.UPDATEOP=/users/$(__UID__)$","__ACCOUNT__.SEARCHOP=/users?$(Filter Suffix)$&limit=$(PAGE_SIZE)$&offset=$(PAGE_OFFSET)$","__ACCOUNT__.DELETEOP=/users/$(__UID__)$","__GROUP__.SEARCHOP=/groups?$(Filter Suffix)$&limit=$(PAGE_SIZE)$&offset=$(PAGE_OFFSET)$","__ACCOUNT__.__GROUP__.CREATEOP=/group_memberships","__ACCOUNT__.__GROUP__.UPDATEOP=/group_memberships","__ACCOUNT__.__GROUP__.SEARCHOP=/users/$(__UID__)$/memberships?limit=$(PAGE_SIZE)$&offset=$(PAGE_OFFSET)$","__ACCOUNT__.__GROUP__.DELETEOP=/group_memberships/$(__MEMBERSHIP__.id)$","__ACCOUNT__.__MEMBERSHIP__.__GROUP__.SEARCHOP=/users/$(__UID__)$/memberships","__ACCOUNT__.email.UPDATEOP=/users/$(__UID__)$/email_aliases","__ACCOUNT__.email.SEARCHOP=/users/$(__UID__)$/email_aliases?limit=$(PAGE_SIZE)$&offset=$(PAGE_OFFSET)$","__ACCOUNT__.email.DELETEOP=/users/$(__UID__)$/email_aliases/$(__MEMBERSHIP__.id)$","__ACCOUNT__.__MEMBERSHIP__.email.SEARCHOP=/users/$(__UID__)$/email_aliases?limit=$(PAGE_SIZE)$&offset=$(PAGE_OFFSET)$","__ACCOUNT__.role.SEARCHOP=/users/$(__UID__)$?fields=role","__ACCOUNT__.is_sync_enabled.SEARCHOP=/users/$(__UID__)$?fields=is_sync_enabled","__ACCOUNT__.is_exempt_from_login_verification.SEARCHOP=/users/$(__UID__)$?fields=is_exempt_from_login_verification" |
|
statusEnableValue |
このエントリは、有効な値を表すターゲット・システムのステータス属性の値を含みます。 デフォルト値:active |
|
enableEmptyString |
このエントリは、構成値を含みます。この構成が true
|
|
specialAttributeTargetFormat |
このエントリには、特殊属性がターゲット・システム・エンドポイントに存在する形式がリストされます。 デフォルト値: |
|
statusAttributes |
このエントリには、アカウントのステータスを含むターゲット・システム属性の名前がリストされます。たとえば、ユーザー・アカウントに使用される__ACCOUNT__オブジェクト・クラスのステータス属性はaccountEnabledです。 デフォルト値: |
|
uidAttributes |
このエントリは、このコネクタにより処理されるすべてのオブジェクトのuid属性を含みます。 デフォルト値: |
|
opTypes |
このエントリは、コネクタでサポートされる各オブジェクト・クラスのHTTP操作タイプを指定します。 デフォルト値:
|
|
statusDisableValue |
このエントリは、無効な値を表すターゲット・システムのステータス属性の値を含みます。 デフォルト値: |
3.3 属性マッピング
ターゲット・アプリケーションの「スキーマ」ページには、Oracle Identity Governanceの属性をターゲット・システムの列にマップする(コネクタによって提供される)デフォルトのスキーマが表示されます。コネクタは、リコンシリエーションおよびプロビジョニング操作中にこれらのマッピングを使用します。
Boxユーザー・アカウントの属性
表3-3に、Oracle Identity Governanceのプロセス・フォーム・フィールドとBoxアプリケーションの列の間のユーザー固有属性マッピングを示します。この表には、特定の属性がプロビジョニングまたはリコンシリエーション中に使用されるかどうか、およびその属性がリコンシリエーション中にレコードをフェッチするための一致キー・フィールドであるかどうかも示されています。
必要に応じて、『Oracle Fusion Middleware Oracle Identity Governanceでのセルフ・サービス・タスクの実行』のターゲット・アプリケーションの作成に関する項の説明に従って、新しい属性を追加したり既存の属性を削除することでデフォルトの属性マッピングを編集できます。
表3-3 Boxユーザー・アカウントのデフォルト属性マッピング
| アイデンティティ属性 | ターゲット属性 | データ型 | 必須プロビジョニング・プロパティ? | プロビジョニング・フィールド? | リコンシリエーション・フィールド? | キー・フィールド? | 大/小文字を区別しない? |
|---|---|---|---|---|---|---|---|
|
Login |
__NAME__ |
String |
あり |
あり |
あり |
いいえ |
いいえ |
|
Name |
name |
String |
あり |
あり |
あり |
あり |
いいえ |
|
Role |
role |
String |
いいえ |
あり |
あり |
いいえ |
いいえ |
|
Language |
language |
String |
いいえ |
あり |
あり |
いいえ |
いいえ |
|
Enable Sync |
is_sync_enabled |
String |
いいえ |
あり |
あり |
いいえ |
いいえ |
|
Job Title |
job_title |
String |
いいえ |
あり |
あり |
いいえ |
いいえ |
|
Phone |
_ENABLE_ |
String |
いいえ |
あり |
あり |
いいえ |
いいえ |
|
Address |
address |
String |
いいえ |
あり |
あり |
いいえ |
いいえ |
|
Space Amount |
space_amount |
String |
いいえ |
あり |
あり |
いいえ |
いいえ |
|
Timezone |
timezone |
String |
いいえ |
あり |
あり |
いいえ |
いいえ |
|
Exempt From Login |
is_exempt_from_login |
String |
いいえ |
あり |
あり |
いいえ |
いいえ |
|
Id |
_UID_ |
String |
いいえ |
あり |
あり |
いいえ |
いいえ |
|
Status |
_ENABLE_ |
String |
いいえ |
いいえ |
あり |
いいえ |
いいえ |
グループの権限
表3-4に、Oracle Identity Governanceのプロセス・フォーム・フィールドとBoxターゲット・アプリケーションの属性間のグループ・フォーム属性マッピングを示します。この表は、プロビジョニング中に特定の属性が必須であるかどうかを示しています。また、リコンシリエーション中に特定の属性が使用されるかどうか、およびこの属性がリコンシリエーション中のレコードのフェッチ用の一致キー・フィールドであるかどうかも示しています。
必要に応じて、『Oracle Fusion Middleware Oracle Identity Governanceでのセルフ・サービス・タスクの実行』のターゲット・アプリケーションの作成に関する項の説明に従って、新しい属性を追加したり既存の属性を削除することでデフォルトの属性マッピングを編集できます。
表3-4 グループ権限用のデフォルト属性マッピング
| 表示名 | ターゲット属性 | データ型 | 必須プロビジョニング・プロパティ? | リコンシリエーション・フィールド? | キー・フィールド? | 大/小文字を区別しない? |
|---|---|---|---|---|---|---|
|
グループ名 |
__GROUP__~__GROUP__~id |
String | いいえ | あり | あり | いいえ |
図3-1に、デフォルトの属性グループ・マッピングを示します。
3.4 相関ルール
ターゲット・アプリケーションの事前定義済ルール、レスポンスおよび状況について学習します。コネクタによってこれらのルールとレスポンスが使用されて、リコンシリエーションが実行されます。
事前定義済のアイデンティティ相関ルール
デフォルトでは、Boxコネクタにより、ターゲット・アプリケーションの作成時に単純相関ルールが提示されます。コネクタは、この相関ルールを使用して、Oracle Identity Governanceリポジトリとターゲット・システム・リポジトリのエントリを比較して、2つのリポジトリの相違を判断し、最新の変更内容をOracle Identity Governanceに適用します。
表3-5に、Boxコネクタのデフォルトの単純相関ルールを示します。必要に応じて、デフォルトの相関ルールを編集したり、新しいルールを追加することができます。複合相関ルールを作成することもできます。単純相関ルールまたは複合相関ルールの追加または編集の詳細は、『Oracle Fusion Middleware Oracle Identity Governanceでのセルフ・サービス・タスクの実行』のターゲット・アプリケーションの作成に関する項を参照してください。
表3-5 Boxターゲット・アプリケーションの事前定義済アイデンティティ相関ルール
| ターゲット属性 | 要素の演算子 | アイデンティティ属性 | 大/小文字を区別する? |
|---|---|---|---|
|
__NAME__ |
次と等しい |
ユーザー・ログイン |
いいえ |
-
__NAME__は、ユーザー・アカウントを識別するターゲット・システム上の単一値の属性です。
-
「ユーザー・ログイン」は、OIGユーザー・フォームのフィールドです。
図3-3に、Boxターゲット・アプリケーションの複合相関ルールを示します。
事前定義済の状況とレスポンス
Boxコネクタにより、ターゲット・アプリケーションの作成時にデフォルトの一連の状況およびレスポンスが提示されます。これらの状況とレスポンスにより、リコンシリエーション・イベントの結果に基づいてOracle Identity Governanceが実行する必要があるアクションを指定します。
表3-5に、Boxターゲット・アプリケーションのデフォルトの状況およびレスポンスを示します。必要に応じて、これらのデフォルトの状況とレスポンスを編集することも、新しい状況とレスポンスを追加することもできます。状況とレスポンスの追加または編集の詳細は、『Oracle Fusion Middleware Oracle Identity Governanceでのセルフ・サービス・タスクの実行』のターゲット・アプリケーションの作成に関する項を参照してください
表3-6 Boxターゲット・アプリケーションの事前定義済の状況とレスポンス
| 状況 | レスポンス |
|---|---|
|
一致しない場合 |
なし |
|
1つのエンティティ一致が見つかった場合 |
リンクの確立 |
|
1つのプロセス一致が見つかった場合 |
リンクの確立 |
図3-4は、デフォルトでコネクタが提供するBoxの状況とレスポンスを示しています。
3.5 リコンシリエーション・ジョブ
ターゲット・システムのターゲット・アプリケーションを作成するとOracle Identity Governanceで自動的に作成されるリコンシリエーション・ジョブについて学習します。
ユーザー・リコンシリエーション・ジョブ
ユーザー・リコンシリエーション・ジョブの属性値を指定する必要があります。
Boxターゲット・ユーザー・リコンシリエーション・ジョブは、ターゲット・システムからすべてのユーザー・レコードをフェッチするために使用されます。
表3-7 Boxターゲット・ユーザー・リコンシリエーション・ジョブのパラメータ
| 属性 | 説明 |
|---|---|
|
Application Name |
ターゲット・システム用として作成したアプリケーションの名前。この値は、ターゲット・アプリケーションの作成時に「アプリケーション名」フィールドで指定した値と同じです。 この値は修正しないでください。 |
|
Filter Suffix |
リコンシリエーションの実行時にターゲット・システムからフェッチされるレコードの検索フィルタを入力します。 サンプル値: フィルタ済リコンシリエーションの詳細は、「リコンシリエーション・ジョブの構成」を参照してください。 |
|
Object Type |
リコンサイルするオブジェクトのタイプ。 デフォルト値: |
参照フィールド同期のリコンシリエーション・ジョブ
参照定義はOracle Identity Governanceの参照フィールドの入力ソースとして使用されます。
Boxグループ参照リコンシリエーション・スケジュール済ジョブは、参照フィールドの同期に使用されます。
表3-8 Boxグループ参照リコンシリエーション・スケジュール済ジョブのパラメータ
| 属性 | 説明 |
|---|---|
|
Application Name |
ターゲット・システム用として作成したアプリケーションの名前。この値は、ターゲット・アプリケーションの作成時に「アプリケーション名」フィールドで指定した値と同じです。 この値は変更しないでください。 |
|
Lookup Name |
ターゲット・システムからフェッチした値を移入するOracle Identity Governanceの参照定義の名前を入力します。 デフォルト値: |
|
Object Type |
リコンサイルするオブジェクトのタイプ。 デフォルト値: |
| Code Key Attribute | コネクタの属性の名前。参照定義(Lookup Name属性の値として指定される)のコード・キー列に値を移入するために使用されます。
デフォルト値: __UID__ |
| Decode Attribute | コネクタの属性の名前。参照定義(Lookup Name属性の値として指定される)のデコード列に値を移入するために使用されます。
デフォルト値: __NAME__ |
Boxアクセス・トークン・ジョブの更新
ITリソースの一部として構成されているアクセス・トークンは60分で期限が切れ、リフレッシュ・トークンは60日間で期限が切れます。Boxアクセス・トークン・ジョブの更新は、(ITリソース内の)アクセス・トークンの値を常に有効に保つために使用されます。このジョブは、50分おきに定期実行されるようスケジュールされます。
ノート:
なんらかの理由でこのスケジューラが60日以上実行されない場合、Box Update Access Token Jobを60日値後に実行すると失敗するため、ITリソースのリフレッシュ・トークン値は期限切れになります。その場合は、新しいアクセス・トークンとリフレッシュ・トークンを手動で生成する必要があります。表3-9 Boxアクセス・トークン・ジョブの更新の属性
| 属性 | 説明 |
|---|---|
|
Access Token Endpoint |
この属性は、新しいアクセス・トークンを取得するBox RESTエンドポイントを含みます。 デフォルト値: |
|
IT Resource Name |
ユーザー・レコードのリコンサイル元のターゲット・システム・インストールに対するITリソースの名前を入力します。 デフォルト値: |
|
Task Name |
この属性は、スケジュール済タスクの名前を保持します。 デフォルト値: デフォルト値は変更しないでください。 |
|
Start Date |
この属性にはジョブの開始日と時間が格納されます。 「カレンダ」ドロップダウンから現在の時間と日付を選択します。 |