メンバー配置転換

    メンバーアカウントを同テナント内の異なるドメインに移動し、External Key、ID、組織の情報を一括で変更します。

    参考

    • 後方互換性の維持のため、ベーシック / プレミアムプランではメンバーが以前に使用していた ID (メールアドレス) をサブメールアドレスとして自動登録します。
    • 移動したメンバーに対して'メンバー修正 API' または'メンバー部分修正 API' を通じた操作を行う場合には、上記の自動登録されたサブメールアドレスも変更対象に含まれます。誤って削除しないようご注意ください。
    • 最高管理者および削除中のメンバーは配置転換できません。
    • 外部トーク連携とメンバーの email
      • 外部トーク連携が有効なメンバーを連携が許可されていないドメインに配置転換することはできません。
      • 外部トーク連携 ID として使用されているメンバーの email が修正された場合、外部トーク連携 ID も自動的に修正されます。
      • このとき、新しい email に禁止ワードが含まれている場合は、サブメールアドレス(ライトプランではサブ ID)として登録された以前の email を外部トーク連携 ID として継続利用します。
    • 原職ドメインのカスタムフィールドは削除されます。

    API の種類

    サーバー API

    Request URL

    • サービス: https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/users/{externalKey}/transfer
    • テスト: https://sandbox-apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/users/{externalKey}/transfer

    HTTP Method

    PUT (Content-Type: application/json; charset=UTF-8)

    Path Parameters

    パラメーター タイプ 上限  必須 説明
    domainId Integer Y 変更元のドメイン ID
    externalKey String 100 字 Y 変更元のメンバーの External Key

    Request Body

    パラメーター タイプ 上限  必須 説明
    organizations[] List Y 変更先ドメインのリスト
    organizations[].domainId Integer Y 変更先のドメイン ID
    organizations[].externalKey String 100 字 Y メンバーの新しい External Key
    Path Parameter と異なる External Key を指定可能。テナント内で一意となること。
    ドメインごとに異なる External Key を指定可。
    organizations[].email String 90 字 Y アカウント
    ベーシック / プレミアムプランで利用している場合には、メールアドレスと同一。
    ライトプランを利用している場合には、ID@グループ名。
    organizations[].represent 値が true の場合、メインで利用するメールアドレスとなる。
    false の場合、兼務ドメインで利用するメールアドレスとなる。(空の値を入れた場合にはメインと同じ値に設定される。)
    ● localpart@domain 形式で記述。
    ● localpart は 2~40 字の英小文字、数字、ドット(.)、ハイフン(-)、アンダーバー(_)のみ使用可。
    ● localpart の 1 文字目は英数字のみ可。
    ● ドット(.)は localpart の最初と最後および連続使用(..)不可。
    organizations[].represent Boolean N 代表会社
    organizations[].levelExternalKey String 100 字 N 職級の External Key
    職級設定を使用している場合のみ指定可。既定値は「なし」。
    organizations[].orgUnits[] List N 組織 List
    organizations[].orgUnits[].externalKey String 100 字 N 組織の External Key
    organizations[].orgUnits[].represent Boolean N 代表組織設定
    organizations[].orgUnits[].positionExternalKey String 100 字 N 役職の External Key
    役職設定を使用している場合のみ指定可。既定値は「なし」。
    organizations[].orgUnits[].manager Boolean N 組織長設定
    既存の組織長が設定されている場合は上書き(既存の組織長は解除される)。
    ● 既定値: false
    organizations[].orgUnits[].display Boolean N 組織図にメンバーとして表示するかどうか。
    ● 既定値: true
    organizations[].orgUnits[].receiveEmail Boolean N チーム機能* の利用設定
    ● 既定値: true
    ● この値が false の場合、全てのチーム機能が使用できない。
    preserveGroup Boolean N 参加グループの維持
    ● 既定値: false (配置転換後、既存の参加グループから削除される)
    メンバーはグループトークルームから自動的に退室し、それまでのトーク内容を確認できない。
    ● この値が true の場合、配置転換後にも参加グループを維持する。

    *チーム機能

    • 組織のトークルームの利用 (ノート/フォルダ/カレンダー含む)
    • (メール) 組織宛に送信されたメールの受信
    • (カレンダー) 組織を対象にした予定招待の受信
    • (Drive) 組織を対象に共有されたフォルダ/ファイルの利用
    • (ホーム) 組織を対象に権限が付与されている掲示板の利用
    • (アンケート) 組織を対象にしたアンケートへの回答
    • (アドレス帳) グループのメンバーとして該当組織を指定した場合、グループのメンバーに含まれる

    Request Example

    PUT https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/users/EX123/transfer
    
    {
      "organizations": [
        {
          "domainId": 456,
          "externalKey": "EX123",
          "represent": true,
          "email": "mizuki.yamamoto@new.example.com",
          "levelExternalKey": "manager",
          "orgUnits": [
            {
              "externalKey": "CSTeam",
              "positionExternalKey": "staff"
            }
          ]
        },
        {
          "domainId": 123,
          "externalKey": "EX123",
          "represent": false,
          "email": "mizuki.yamamoto@example.com",
          "levelExternalKey": "100000000009970",
          "orgUnits": [
            {
              "externalKey": "Sales1",
              "positionExternalKey": "staff",
              "represent": true,
              "display": false
            }
          ]
        }
      ]
    }
    

    Response

    呼び出しに成功すると HTTP 200 コードを返します。

    Error Code

    呼び出しに失敗するとエラーコードとエラーメッセージを返します。
    エラーコードは組織連携 REST API エラーコードを参照してください。