POST/users/{userId}/move

ユーザーを同テナント内の異なるドメインに移動し、ユーザーの ExternalKey、email、組織情報を一括で変更します。

転換時に引き継がれる情報については以下の通りです。

トークの引き継ぎ

  • 転換するとトークも引き継がれます。ただし、グループ/組織/外部トーク連携のトークルームについてはそれぞれの引き継ぎ条件に従います。

グループの引き継ぎ

  • 参加中のグループ (グループトーク含む) を引き継ぐ場合、preserveGroup に true を指定します 。

組織の引き継ぎ

  • 所属している組織 (組織トーク含む) を引き継ぐ場合、organizations リストに該当の domain 情報を含め、かつ、所属していた組織の orgUnitId を設定します。

外部トーク連携の引き継ぎ

  • 外部ユーザーとのトークルームを移行するには、対象のユーザーが転換元/先の両方で外部連携権限を持つことが必要です。
  • 外部トーク連携 IDとして使用されているユーザーの email が更新された場合、外部トーク連携 ID も自動的に更新される。
    • このとき、新しい email に禁止ワードが含まれている場合、以前の email をサブメールアドレスとして登録し、外部トーク連携 ID として継続利用する。

監査ログの引き継ぎ

  • トーク履歴含め、監査ログは移行されません。

その他ユーザーデータの引き継ぎ

  • ユーザーが持つ各データ (カレンダー、タスク、連絡先など) も一緒に引き継がれます。

制限

  • 削除中のユーザーまたは最高管理者は配置転換できません。
  • 転換元ドメインのカスタムフィールドは削除されます。

注意

  • ユーザーの登録/更新/部分更新/配置転換 API は、同じユーザーに対しては同時に呼び出してはならず、順番通りに呼び出すことを推奨します。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

user
directory

HTTP Request

POSThttps://www.worksapis.com/v1.0/users/{userId}/move

Path Parameters

ParameterTypeDescription
userId string 

ユーザーを特定する ID (URL エンコードする)

  • ユーザー ID (userId)
  • ログイン ID (email)
  • ユーザーの ExternalKey (externalKey:{userExternalKey})

required
example : userf7da-f82c-4284-13e7-030f3b4c756x 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
organizations array (UserOrganization) 

組織情報


minItems : 1 
userExternalKey string 

顧客企業で管理するユーザーの ExternalKey
"%"、"\"、"#"、"/"、"?" の特殊文字は利用できない。

注意
userExternalKey は以下の優先順位で適用されます。

    1. 本プロパティ (最上位の userExternalKey)
    1. primary=true である組織情報 (organizations) の userExternalKey
    1. 最初の組織情報 (organizations) の userExternalKey

maxLength : 100
nullable : true 
preserveGroup boolean 

参加グループの維持の可否 (既定値: false) この値が false の場合、ユーザーが所属していたグループは配置転換後に維持されない。したがって、ユーザーは利用中のトークルームから退室し、それまでのトーク内容を確認できなくなる。 配置転換後も参加グループを維持するには、この値を true に設定する。


default : false 

UserOrganization

PropertyTypeDescription
domainId integer 

ドメイン ID


required
format : int32 
primary boolean 

代表ドメインフラグ
必ず代表 (primary: true) を1つ設定してください。 代表を設定しない場合、自動的に一番最初の値が代表に設定されます。


required 
userExternalKey string 

顧客企業で管理するユーザーの ExternalKey

注意

  • organizations[].userExternalKey ではなく、user の userExternalKey の値を設定・参照してください。
  • ユーザーの登録、ユーザーの更新、ユーザーの部分更新 で organizations[].userExternalKey を指定しても、値は反映されません。
    "%"、"\"、"#"、"/"、"?" の特殊文字は利用不可。

maxLength : 100
nullable : true 
email string 

メールアドレス
アドバンストプランで原職と兼職に異なるメールアドレスを設定するときに使用。
localpart には、新たに admin、administrator を指定できない。


maxLength : 90 
levelId string 

職級 ID
職級設定を使用している場合のみ指定可 (既定値: なし)

  • 職級 ID (levelId)
  • 職級の ExternalKey (externalKey:{levelExternalKey})

nullable : true 
orgUnits array (orgUnit) 

組織リスト


minItems : 0
maxItems : 30 

orgUnit

PropertyTypeDescription
orgUnitId string 

組織 ID

  • 組織 ID (orgUnitId)
  • 組織の ExternalKey (externalKey:{orgUnitExternalKey})

required 
primary boolean 

代表組織フラグ
必ず代表 (primary: true )を1つ設定してください。 代表を設定しない場合、自動的に一番最初の値が代表に設定されます。


required 
positionId string 

役職 ID
役職設定を使用している場合のみ指定可 (既定値: 役職なし)

  • 役職 ID (positionId)
  • 役職の ExternalKey (externalKey:{positionExternalKey})

nullable : true 
isManager boolean 

組織長フラグ (既定値: false)
既存の組織長が設定されている場合は上書き (既存の組織長は解除される)。


default : false 
visible boolean 

ユーザー公開フラグ (既定値: true)
組織図から組織のユーザーとして表示するかどうか。


default : true 
useTeamFeature boolean 

組織のトークルーム機能の利用フラグ (既定値: true)
組織に所属しているがトークルームでのメッセージ受信やファイル共有、組織メール受信などの、組織のトークルーム機能を制限したい場合にこのパラメータを利用する。
この値が true の場合、以下の機能を利用可能。

  • 組織トークルームのメンバーとして参加 (トーク、ノート、カレンダー、フォルダの閲覧)
  • 組織宛メールの受信
  • 組織カレンダーの参照、および宛の予定招待の受信
  • 組織宛に共有された掲示板、Drive、アンケート回答
  • 組織をグループのユーザーとして設定した場合、グループのユーザーに含まれる この値が false の場合、組織に提供される上記のすべての機能は利用できない。
    組織のユーザーとして所属しているが、上記のような組織のトークルーム機能を利用しない場合、この値を false に設定する。

default : true 

Request Example

example

1{2  "organizations": [3    {4      "domainId": 10000001,5      "primary": true,6      "email": "localpart@example.com",7      "levelId": "levelaa7-b824-4937-66af-042f1f43cefa",8      "orgUnits": [9        {10          "orgUnitId": "orgunitf-f27f-4af8-27e1-03817a911417",11          "primary": true,12          "positionId": "position-7027-4a02-b838-6f52b5e38db7",13          "isManager": true,14          "visible": true,15          "useTeamFeature": true16        }17      ]18    }19  ],20  "userExternalKey": null,21  "preserveGroup": false22}

Response

HTTP 204

No Content

HTTP 400

Bad Request

HTTP 404

Not Found