本ページでは、カスタムアプリにおけるSCIM連携について説明します。
アプリカタログに掲載のないアプリであってもSCIM APIを提供しているアプリであれば以下の機能を利用できる場合があります。
- アカウント同期
- プロビジョニング
- デプロビジョニング
- 現時点ではSCIM v2にのみ対応しており、SCIM v2の標準仕様に則っていることを前提としています。
- 対象アプリのSCIM仕様によって実行可能なアクションは異なります。
- SCIM連携に関するサポートはベストエフォートでの対応となります。
目次
SCIM連携の有効化方法
- ［マイアプリ］→ カスタムアプリの詳細ページ →［設定］→［SCIM連携］→［有効にする］をクリックします。
- 表示されたモーダル内に後述の情報をそれぞれ入力し、［有効化］をクリックします。
連携に必要な各設定
SCIMエンドポイントURL
対象アプリのSCIMエンドポイントURLを設定してください。
多くの場合、「https://api.example.com/scim/v2」のような形式です。
認証方式
対象アプリのSCIM仕様に合わせて以下のいずれかを設定してください。
- Bearer Token
- Basic認証
- OAuth2 Client Credentials
Bearer Token選択時
対象アプリ側で発行した「トークン」を入力します。
Basic認証選択時
設定したBasic認証用の「ユーザー名」および「パスワード」を入力します。
OAuth2 Client Credentials選択時
対象アプリ側の以下情報を入力します。
- Token Endpoint URL
- Client ID
- Client Secret
- スコープ（任意）
SCIM連携情報の確認
SCIM連携情報の確認画面は次のとおりです。
ステータス
接続が完了している場合、「接続済み」のステータスが表示されます。
接続をテストする
［テスト接続］を実行すると、設定したエンドポイントおよび/Usersエンドポイントへの接続・認証が正常に機能しているかの確認が可能です。
スキーマを再取得する
連携追加時に対象アプリの /Schemas エンドポイントからスキーマ情報を取得しています。
正しく取得ができていない場合には［スキーマを再取得］から再取得が可能です。
/Schemas エンドポイントが404/405/501などを返す場合は、フォールバックとしてアカウントを1件サンプルとして取得し、スキーマを推論します。
/Schemas エンドポイントが利用できず、かつアプリ内に取得可能なアカウントが0件の場合にエラーが発生する場合があります。
SCIM連携を無効化する
［無効にする］をクリックしてSCIM連携を無効化します。
アカウント同期属性のマッピング
［アカウント同期属性マッピング］→［編集］から「SCIM API側の属性（SCIM属性）」を「freee IT管理のカスタムアプリ側の属性（カスタムアプリ属性）」にどのようにマッピングするかを設定します。
スキーマ取得時に取得したサンプルアカウントが実際に持っている値が「例: XXX」の形式でヒントとして表示されます。
例を参考に、「メールアドレス」と「emails[].value」、「表示名（表示）」と「displayName」のようなマッピングを設定します。
プロビジョニング属性のマッピング
［プロビジョニング属性マッピング］→ 各属性の［・・・（三点リーダー）］→［編集］から「freee IT管理のメンバー側の属性（メンバー属性）」を「SCIM API側の属性（SCIM属性）」にどのようにマッピングするかを設定します。
「必須」ラベルが付いている属性は設定が必須となっています。
同期の実行スケジュール
SCIM連携が有効化されると、アプリカタログから連携追加可能なアプリと同様に、アカウント同期ステータスおよび［アカウントを同期］ボタンが表示されます。
アカウント同期の実行スケジュール設定については「【マイアプリ】アカウント同期スケジュールを設定する」のヘルプページをご確認ください。
プロビジョニング・デプロビジョニングの実行
アプリカタログから連携追加可能なアプリと同様に、メンバープロフィール・オートメーション・アカウント一覧などからアカウントの作成・削除が実行可能です。