> For AI agents: the complete documentation index is available at /resource/ucidm/docs/on-premise/dev/llms.txt, the full documentation bundle is available at /resource/ucidm/docs/on-premise/dev/llms-full.txt.

# Google Workspace 外部連携モジュール \{#google-workspace-destination-module}

UCIDM では [Google Workspace](https://workspace.google.com/intl/en_jp/lp/business/) に対して ID 連携できます。

## Google Workspace 外部連携設定手順 \{#google-workspace-destination-setup}

### Google Workspace 外部連携設定 \{#google-workspace-destination-settings}

管理画面にて Google Workspace の外部連携設定が行えます。ホーム画面の「外部連携設定」を選択し、外部連携設定一覧画面に遷移します。外部連携設定一覧画面で、登録ボタンを押下することで新規外部連携設定画面が表示されます。

![](/resource/ucidm/docs/on-premise/static/image/federation-setting.a8162487da.png)
この新規外部連携設定画面の各セクションで詳細内容を設定します。

### 種別および基本情報 \{#destination-type-basic-info}

外部連携設定の種別および基本情報を指定します。

- 外部連携先の種別
  - Google を指定します
  - 既存の Google 外部連携設定の内容を利用する場合は、「既存の外部連携先を利用」を選択し、利用元の外部連携設定を選択してください
- 連携 ID
  - 一意の連携 ID を指定します
- 外部連携先 ID
  - 任意の値を指定します
- 説明

### 連携設定 \{#federate-settings}

Google 外部連携の連携設定を行います。設定項目と内容は次になります。

- ドライランモード
  - 接続の取得やエントリの検索は行いますが、実際にエントリの追加/変更/削除は行わないモードとなります
  - 主にテスト時の動作確認等に使うことを想定しています
- クライアントメールアドレス
  - Google の Client Email
- 秘密鍵
  - Google の秘密鍵
- Subject
  - Google の Subject (主に管理者のメールアドレスを指定)
- ドメイン名
  - Google Workspace のドメイン名を指定します
- ユーザーステータス設定情報を使用する
  - ユーザープロファイルのステータス設定画面で指定した有効無効設定の情報を利用して、ユーザーのステータスの値を取得する場合は on にします
- ステータス用属性名
  - ユーザーステータス設定情報を使用しない場合にこちらの設定が使われます

#### 実施しない操作の設定 \{#skip-operations}

- ユーザー追加/更新を行わない
  - Google Workspace に対してユーザー追加/更新を行わない場合は、この項目をオン（true）にしてください
- ユーザー削除を行わない
  - Google Workspace に対してユーザー削除を行わない場合は、この項目をオン（true）にしてください
- ユーザーパスワード更新を行わない
  - Google Workspace に対してユーザーパスワード更新を行わない場合は、この項目をオン（true）にしてください
- グループ追加/更新を行わない
  - Google Workspace に対してグループ追加/更新を行わない場合は、この項目をオン（true）にしてください
- グループ削除を行わない
  - Google Workspace に対してグループ削除を行わない場合は、この項目をオン（true）にしてください
- グループメンバー追加を行わない
  - Google Workspace に対してグループメンバー追加を行わない場合は、この項目をオン（true）にしてください
- グループメンバー削除を行わない
  - Google Workspace に対してグループメンバー削除を行わない場合は、この項目をオン（true）にしてください

#### 前処理・後処理スクリプト設定 \{#pre-post-processing-scripts}

UCIDM では、外部連携処理の前後で任意のシェルスクリプトを実行できます。

次の [外部連携の前処理/後処理で実行するスクリプトの配置](/resource/ucidm/docs/on-premise/dev/administration/admin-ui/destination/script.md) を参考に、スクリプトファイルを配置後、[外部連携の前処理/後処理で実行するスクリプトの設定](/resource/ucidm/docs/on-premise/dev/administration/admin-ui/scriptsettings.md) を参考に、実行したいスクリプトファイルを指定してください。

### マッピング \{#mapping}

Google Workspace 外部連携の以下マッピング設定を行います。以下順序でマッピングが適用されます。

- PrimaryID マッピング
  - 新規外部連携設定作成画面においては、「詳細設定を表示」を押下することで設定が可能になります
- 属性マッピング

それぞれのマッピング設定について説明します。

#### PrimaryID マッピング \{#primaryid-mapping}

次の [PrimaryID マッピング設定](/resource/ucidm/docs/on-premise/dev/administration/admin-ui/primaryid-mapping.md) を参考にしてください。

#### 属性マッピング \{#attribute-mapping}

次の [属性マッピング設定](/resource/ucidm/docs/on-premise/dev/administration/admin-ui/mappings.md) を参考にしてください。

- Google Workspace では階層構造を持つ属性があります。
  - 例えば、name 内の givenName に対して属性値をマッピングする場合は、「name.givenName」に対してマッピングをする必要があります。
- Google Workspace では階層構造に加えて、配列を持つ属性があります。
  - 例えば、emails 内の 最初の配列要素における、address に対して属性値をマッピングする場合は、「emails.0.address」に対してマッピングをする必要があります。
  - 配列の要素番号は、0, 1, 2, ... の形で 0 から始める番号で指定する必要があります。

以下は Google Workspace 外部連携のユーザーマッピング設定の一例です。

| 連携先の属性名                   | 連携元の属性名   | ビルトイン関数名 | テンプレート文字列 | 固定値   |
| :------------------------ | :-------- | :------- | :-------- | :---- |
| name.familyName           | sn        | --       | --        | --    |
| name.givenName            | givenName | --       | --        | --    |
| hashFunction              | --        | --       | --        | crypt |
| orgUnitPath               | --        | --       | --        | /     |
| suspended                 | --        | --       | --        | false |
| changePasswordAtNextLogin | --        | --       | --        | true  |

以下は Google Workspace 外部連携のグループマッピング設定の一例です。

| 連携先の属性名     | 連携元の属性名     | ビルトイン関数名 | テンプレート文字列 | 固定値 |
| :---------- | :---------- | :------- | :-------- | :-- |
| description | description | --       | --        | --  |

また、以下の属性は Google Workspace 外部連携モジュール独自のマッピングになるため、合わせてご参照ください。

#### ユーザ属性 \{#user-attributes}

##### primaryEmail 属性 \{#primaryemail-attribute}

本属性については、連携されてきた primaryID の値を使用し、`${primaryID}@${ドメイン}` の値が自動でセットされるので、マッピング設定は必要ありません。

##### hashFunction 属性 \{#hashfunction-attribute}

本属性のマッピング設定をする場合は、以下のいずれかの値が連携されるよう設定してください。

- crypt
- SHA-1
- MD5

##### suspended 属性 \{#suspended-attribute}

ユーザの有効化/無効化を制御するための属性となります。この属性に対して、true/false が設定されるようマッピングを行うことで、ユーザの有効化/無効化のステータスを制御することができます。

ここで、有効化の場合は false、無効化の場合は true が割り当てられる必要があることにご注意ください。必要に応じて、マッピング設定の `事前定義済みのビルトイン関数` の `invertBooleanValue` をご使用ください。

#### グループ属性 \{#group-attributes}

##### email 属性 \{#email-attribute}

本属性については、連携されてきた primaryID の値を使用し、`${primaryID}@${ドメイン}` の値が自動でセットされるので、マッピング設定は必要ありません。

### ルーティング \{#routing-setting}

連携するユーザー／グループの決め方について設定します。全ユーザー・全グループをそのまま連携する際は「すべて連携」を選択します。

ルーティング設定の詳細については [ルーティング設定](/resource/ucidm/docs/on-premise/dev/administration/admin-ui/index.md#external-federation-routing) の内容を参考にしてください。

メンバーシップブリッジ設定も行えます。詳細については [メンバーシップブリッジ設定](/resource/ucidm/docs/on-premise/dev/administration/admin-ui/index.md#external-federation-membership-bridge) の内容を参考にしてください。

## Google Workspace 外部連携モジュールの留意事項 \{#google-workspace-destination-notes}

- 更新操作直後に Google 管理コンソールにてユーザー/グループを閲覧すると更新前の状態が表示される場合があります