メインコンテンツへスキップ

ダイレクトSCIM API

Kelsi Belanger
  • 更新

この記事では、手動API呼び出しを利用してユーザープロビジョニングを更新する方法について説明します。

説明動画をご希望の場合は、このセクションに進んでください。

このプロセスは、WorkvivoのIT管理者ユーザーが管理パネルのプロビジョニング設定にアクセスすることで開始できます。

スクリーンショット 2025-06-25 (11.37.46)AM.png[SCIMプロバイダー] で [その他] を選択し、SCIMシークレットトークンを生成します。


さらに、変更できるパラメーターが他にもいくつかあります。

  • POST通話からユーザーを再アクティブ化できるようにする
  • SCIM PUT での認証ロールの変更を許可する - ユーザー ロールが SCIM 呼び出しを介して管理されている場合は、これを有効にすることをお勧めします。管理パネルで管理されている場合は、この設定を 『No』 のままにします
  • ユーザー認証モードの更新を許可する-プロビジョニングがハイブリッドアプローチ（WorkvivoのユーザーはSSOとパスワードでログイン）に設定されている場合は、これを有効にすることをおすすめする


以下にPOST、PUT、PATCHの例を示しますので、ご参照ください。また、参考用としてサンプルのJSONコレクションも添付しています。

Workvivoの担当者（リリース前はオンボーディングPM、リリース後は [Submit a request（リクエストを送信）] ボタンからサポートチーム）に、各従業員プロフィールにどのような従業員データポイント（他のチームタイプ、カスタムフィールドなど）をお知らせいただければ、弊社側で用意し、必要に応じて特定の属性呼び出しに関する詳細を提供いたします。

注：

  • ExternalIDはユーザーごとに一意であり、変更されないことを確認してください。
  • また、NULL値をWorkvivoに渡さないでください。代わりに、空の文字列を使用するか、操作を削除してください。


SCIM POSTリクエストのサンプル：
リクエストURL：https://[企業ドメイン]/scim/v2/scim/Users/
例：https://company.workvivo.com/scim/v2/scim/Users/
リクエストメソッド：POST（作成）

サンプルリクエスト： 

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
    ],
    "externalId": "8715", // 一意の識別子 
    "userName": "joe.bloggs@workvivo.com",
    "displayName": "Joe Bloggs",
    "name": {
        "formatted": "Joe Bloggs",
        "familyName": "Bloggs",
        "givenName": "Joe"
    },
    "emails": [
        {
            "type": "work",
            "value": "joe.bloggs@workvivo.com",
            "primary": true
        }
    ],
    "phoneNumbers": [
        {
            "primary": true,
            "type": "work",
            "value": "1234567"
        },
        {
            "primary": true,
            "type": "mobile",
            "value": "+1234567"
        }
    ],
    "addresses": [
        {
            "locality": "Ireland", // Secondary Team
            "type": "work"
        }
    ],
    "title": "Technical Support",
    "active": true,
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "department": "Customer Support", // 主要チーム
        "costCenter": "Operations", // 第3チーム
        "manager": {
            "displayName": "",
            "value": "654321",
            "$ref": ""
        },
        "taxonomies": [ // その他のチーム
            {
                "displayName": "Customer Experience",
                "type": "Division"
            },
            {
                "displayName": "Workvivo",
                "type": "Company"
            }
        ]
    }
}

 


SCIM PUT 要求の例:

リクエストURL：https://[顧客ドメイン]/scim/v2/scim/Users/662096
例： https://company.workvivo.com/scim/v2/scim/Users/662096

リクエストメソッド：PUT（作成または更新）

リクエストの例:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
    ],
    "externalId": "8751", //一意の識別子 
    "userName": "Joe.bloggs2@workvivo.com",
    "name": {
        "formatted": "Joe Bloggs",
        "familyName": "Bloggs",
        "givenName": "Joe"
    },
    "emails": [
        {
            "type": "work",
            "value": "Joe.bloggs2@workvivo.com",
            "primary": true
        }
    ],
    "phoneNumbers": [
        {
            "primary": true,
            "type": "work",
            "value": "3534353"
        },
        {
            "primary": true,
            "type": "mobile",
            "value": "+354769999"
        }
    ],
    "addresses": [
        {
            "locality": "Location Name", // Secondary Team
            "type": "work"
        }
    ],
    "title": "Job Title",
    "active": true,
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "department": "Department", // 主要チーム
        "costCenter": "Operations", // 第3チーム
        "manager": {
            "displayName": "",
            "value": "654321", // Workvivo ID
            "$ref": ""
        },
        "taxonomies": [  // その他のチーム
            {
                "displayName": "Dv1",
                "type": "Division"
            },
            {
                "displayName": "Workvivo",
                "type": "Company"
            }
        ]
    }
}

 

 


SCIM PATCH 要求の例:

リクエストURL：https://[顧客ドメイン]/scim/v2/scim/Users/662096
例： https://company.workvivo.com/scim/v2/scim/Users/662096

リクエストメソッド：Patch（更新）

リクエストの例:

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operations": [
        {
            "op": "add",
            "path": "title",
            "value": "New Job Title"
        }
    ]
}

 


デフォルト属性とWorkvivoへのマッピング：
 

特定の用語マッピングについては、以下を参照してください。必要に応じて、以下の電話リクエストなど、Workvivoの連絡先に遠慮なく連絡してください

  • 外部 ID: ユーザーごとに提供される一意の識別子で、ユーザー情報を固定します。これにより、ユーザープロファイルの変更が決まります
  • ユーザー名 と 電子メール:Workvivoの電子メールフィールド
  • FirstName: 名/名
  • 苗字:苗字/苗字
  • 表示名:表示名
  • アクティブ: ユーザーのアカウントをアクティブにするか無効にするか
  • JobTitle: ユーザーの役職
  • DirectDial:直通(勤務先)電話番号
  • MobilePhone:携帯電話番号
  • DateOfBirth: 生年月日
  • HireDate: 採用日
  • マネージャー:組織図を生成するユーザーのマネージャー
    • メール形式か WorkvivoID である必要がありますのでご注意ください。メールの場合、SCIM プロバイダーは最初のスクリーンショットで Okta である必要があります

その他のチームタイプ:

Workvivoのチームタイプを追加または調整するには、Workvivoの連絡先に連絡して

  • 部門: プライマリ構造の設定に関連するデフォルトのチームタイプ
  • 地域：二次構造の設定に関連するデフォルトのチームタイプ
  • コストセンター:三次構造の設定

チームタイプおよび構成設定の詳細については、こちらのヘルプセンター記事をご参照ください。

以下のクリップで、動画による操作手順をご確認ください：

 

関連記事