この記事では、手動の API 呼び出しを利用してユーザー プロビジョニングを更新する方法について説明します。まず、WorkvivoのIT管理者ユーザーは、管理者パネルのプロビジョニング設定にアクセスできます。
SCIM プロバイダーとして [その他] を選択し、SCIM シークレット トークンを生成します。
さらに、変更できるパラメーターが他にもいくつかあります。
- POST通話からユーザーを再アクティブ化できるようにする
- SCIM PUT での認証ロールの変更を許可する - ユーザー ロールが SCIM 呼び出しを介して管理されている場合は、これを有効にすることをお勧めします。管理パネルで管理されている場合は、この設定を 『No』 のままにします
- ユーザー認証モードの更新を許可する-プロビジョニングがハイブリッドアプローチ(WorkvivoのユーザーはSSOとパスワードでログイン)に設定されている場合は、これを有効にすることをおすすめする
参照用に、以下のサンプルの POST、PUT、および PATCH の例を見つけてください。また、参照用のサンプルjsonコレクションも添付されています。
各従業員プロファイルにどのような従業員データポイントを記載したいか(つまり、カスタムフィールドの追加チームタイプ)、必要に応じて、私たちの側でそれを行い、特定の属性呼び出しの詳細を提供できます。
ノート:
- ExternalIDはユーザーごとに一意であり、変更されないことを確認してください。
- また、NULL値をWorkvivoに渡さないでください。代わりに、空の文字列を使用するか、操作を削除してください。
SCIM POST リクエストの例:
リクエストURL:https://[企業ドメイン]/scim/v2/scim/Users/
例:https://company.workvivo.com/scim/v2/scim/Users/
リクエスト方法:POST(作成)
リクエストの例:
{
"メール": [
{
"type": "work",
"value": "Joe.Bloggs@example.com",
"primary": true
}
],
"displayName": "ジョー・ブロッグス",
"アドレス": [
{
"locality": "Ireland",
"type": "work"
}
],
"displayName": "ジョー・ブロッグス",
"メタ": {
"resourceType": "User"
},
"スキーマ": [
"urn:ietf:params:scim:schemas:core:2.0:User"、
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:ユーザー"
],
"名前": {
"formatted": "Joe Bloggs",
"familyName": "Bloggs",
"givenName": "Joe"
},
"externalId": "JBloggs"、
"アクティブ": true,
"authRoles": ["管理者", "モデレーター"],
"authMode": "パスワード"
"ユーザー名": "Joe.Bloggs@example.com",
"title": "QAテスター",
"phoneNumbers":
[
{ "primary": true, "type": "work", "value": "+1 123 12345" }、
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{
"department": "部門用語1",
"costCenter": "costCenterの用語1",
"マネージャー": {
"displayName": "Mary Berry",
"value": "343826",
"$ref": "https://company.workvivo.com/scim/v2/scim/Users/343826"
},
"分類法": [
{
"displayName": "Team Term",
"type": "Team Label"
}、
{
"displayName": "Northeast",
"type": "Region"
}
]
}
}
SCIM PUT 要求の例:
リクエストURL:https://[顧客ドメイン]/scim/v2/scim/Users/662096
例: https://company.workvivo.com/scim/v2/scim/Users/662096
要求方法: PUT (作成または更新)
リクエストの例:
{
"メール": [
{
"type": "work",
"value": "Joe.Bloggs@example.com",
"primary": true
}
],
"displayName": "ジョー・ブロッグス",
"アドレス": [
{
"locality": "Ireland",
"type": "work"
}
],
"displayName": "ジョー・ブロッグス",
"メタ": {
"resourceType": "User"
},
"スキーマ": [
"urn:ietf:params:scim:schemas:core:2.0:User"、
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:ユーザー"
],
"名前": {
"formatted": "Joe Bloggs",
"familyName": "Bloggs",
"givenName": "Joe"
},
"externalId": "JBloggs"、
"アクティブ": true,
"id": "662096",
"ユーザー名": "Joe.Bloggs@example.com",
"title": "QAテスター",
"phoneNumbers":
[
{ "primary": true, "type": "work", "value": "+1 123 12345" }、
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{
"department": "部門用語1",
"costCenter": "costCenterの用語1",
"マネージャー": {
"displayName": "Mary Berry",
"value": "343826",
"$ref": "https://company.workvivo.com/scim/v2/scim/Users/343826"
},
"分類法": [
{
"displayName": "Team Term",
"type": "Team Label"
}、
{
"displayName": "Northeast",
"type": "Region"
}
]
}
}
SCIM PATCH 要求の例:
リクエストURL:https://[顧客ドメイン]/scim/v2/scim/Users/662096
例: https://company.workvivo.com/scim/v2/scim/Users/662096
リクエスト方法:パッチ (更新)
リクエストの例:
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
「オペレーション」:
[
{
"op": "Replace",
"path": "active",
"value": "False" // Deactivate user = set to False
}、
{
"op": "置換",
"path": "title", // 役職
"value": "プラントQA"
{
"op": "Replace",
"path": "mobilePhoneNumber", // Mobile Number
"value": null
},
{
"op": "Replace",
"path": "workPhoneNumber",
"value": "+66 61 6"// Direct Dial
}、
{
"op": "Replace",
"path": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department", // Primary Team Type
"value": "IT"
}、
{
"op": "Replace",
"path": "addresses[type eq \"work\"].locality", // Secondary Team Type
"value": "Paris"
}、
],
}
デフォルトの属性とWorkvivoへのマッピング:
特定の用語マッピングについては、以下を参照してください。必要に応じて、以下の電話リクエストなど、Workvivoの連絡先に遠慮なく連絡してください
- 外部 ID: ユーザーごとに提供される一意の識別子で、ユーザー情報を固定します。これにより、ユーザープロファイルの変更が決まります
- ユーザー名 と 電子メール:Workvivoの電子メールフィールド
- FirstName: 名/名
- 苗字:苗字/苗字
- アクティブ: ユーザーのアカウントをアクティブにするか無効にするか
- 表示名:表示名
- DirectDial:直通(勤務先)電話番号
- MobilePhone:携帯電話番号
- DateOfBirth: 生年月日
- HireDate: 採用日
- JobTitle: ユーザーの役職
-
マネージャー:組織図を生成するユーザーのマネージャー
- これは電子メール形式またはWorkvivoIDである必要があります
- これは電子メール形式またはWorkvivoIDである必要があります
その他のチームタイプ:
Workvivoのチームタイプを追加または調整するには、Workvivoの連絡先に連絡して
- 部門: プライマリ構造の設定に関連するデフォルトのチームタイプ
- 地域: プライマリ セカンダリ設定に関連する既定のチーム タイプ
- コストセンター:三次構造の設定
チームの種類と構造設定の詳細については、こちらのヘルプセンターの記事をご覧ください