メンバーの ID 変更

    メンバーの ID (ベーシック以上のプランの場合はメールアドレス)を変更します。グループ会社構成の場合、メインドメインの ID のみ修正可能です。変更前の ID はサブ ID として登録され、他のメンバーに再利用することはできません。

    参考

    • 後方互換性の維持のため、以前に使用していた ID はサブ ID (ベーシック / プレミアムプランではサブメールアドレス) として保持されます。
    • 'メンバー修正 API' または'メンバー部分修正 API' を通じた操作を行う場合に、上記の自動登録されたサブ ID も変更対象に含まれます。誤って削除しないようご注意ください。
    • 'メンバー修正 API' または'メンバー部分修正 API' でもメンバーの ID 変更は可能ですが、メンバーが以前に使用していた ID をサブ ID として自動登録しません。サブ ID は aliasEmails の値を基準として修正されます。
    • 外部連携時の注意点
      • email の値が外部連携の ID としても使用されている場合、 email の値変更にあわせて外部連携の ID も自動で修正されます。
        • ただし、変更後の email に外部連携の禁止ワード (admin 等) が含まれている場合、サブ ID(サブメールアドレス) として登録された変更前のemail の値を引き続き外部連携 ID として使用します。

    API の種類

    サーバー API

    Request URL

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

    HTTP Method

    POST

    Path parameters

    パラメーター タイプ 上限 必須 説明
    domainId Integer Y ドメイン ID
    externalKey String 100 字 Y メンバーの External Key
    email String 90 字 Y 変更するアカウント。
    ライトプランで利用している場合には、ID@グループ名。
    ● localpart@domain 形式で記述。
    ● localpart は 2~40 字の英小文字、数字、ドット(.)、ハイフン(-)、アンダーバー(_)のみ使用可。
    ● localpart の 1 文字目は英数字のみ可。
    ● ドット(.)は localpart の最初と最後および連続使用(..)不可。

    Request parameters

    Request Body

    Request Example

    POST https://apis.worksmobile.com/r/apiid/contact/v2/domains/123/users/EX123/emails/represent/localpart@domain.com
    

    Response

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

    Error code

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