メンバー即時削除

    メンバー即時削除をリクエストします。最高管理者の即時削除はできません。

    対象メンバーは即時で強制ログアウトとなり、再ログインできません。

    この API は Developer Console にてメンバー即時削除 API の利用を有効にしてから 24 時間後より使用可能です。
    また、6 か月間利用がない場合、メンバー即時削除 API の利用設定は自動的に無効となります。
    再利用時は Developer Console から再設定してください。

    API の種類

    サーバー API

    Request URL

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

    HTTP Method

    DELETE

    Path Parameters

    パラメーター タイプ 上限 必須 説明
    domainId Integer Y ドメイン ID
    externalKey String 100bytes Y 即時削除したいメンバーの External Key

    Request Parameters

    パラメーター タイプ 上限 必須 説明
    adminExternalKey String 100bytes Y 最高管理者の External Key

    Request Example

    DELETE https://sandbox-apis.worksmobile.com/r/apiid/organization/v2/domains/123/users/EX123?adminExternalKey=EXADMIN
    

    Response

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

    Error Code

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