LINE WORKS Developers

コミュニティ

LINE WORKSのテクニカルエキスパート及び開発者と
コードのサンプル、リソース、Tip等を共有し問題解決への相談が可能です。

??dev_메인_타이틀_모바일_ja_JP??

組織連携

メンバー即時削除APIのドキュメント記載について

画像

ワークス八郎

2019.09.24既読 115

下記URLのDeveloperDocumentの記載に従ってメンバー即時削除APIを実行したところ、必ず以下のエラーが発生します。
{
"code": "INVALID_PARAMETER",
"message": "externalKey is a required field. (externalKey)",
"domain": "contact"
}
なお、メンバー即時削除APIの有効化設定は済ませています。
原因をご教示ください。

コメント4

  • 画像

    LINE WORKS 公式アカウント

    externalKey is a required field というエラーが 出ておりますので、externalKey の設定をご確認ください。
    メンバー即時削除 API で使用する externalKey は2種類あります。
    ①リクエスト URL に含める、削除したいメンバーの externalKey
    ②request Parameter に含める、管理者権限を持つメンバーの externalKey

    両方の設定をご確認ください。

    2019.09.30

    0
  • ご指摘いただいた①②とも、前記のドキュメント記載(以下に抜粋)のとおり、間違いなく設定できていることは確認しております。

    ---------------------------------------------------------
    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

    ---------------------------------------------------------

    このadminExternalKeyを、ドキュメントに記載のあるRequest Parameterではなく、Request Bodyに以下のようにJSON形式で指定したところ、期待通り即時削除することができました。(PostMan v7.6.0を使用)

    ドキュメントの記載およびExampleが誤っている可能性はあり得ませんか?ご確認ください。

    {
     "adminExternalKey": "XXXX"
    }

    2019.09.30

    0
  • 画像

    LINE WORKS 公式アカウント

    エラーの際の Header 情報ですが、Content-Type を application/json に設定しておりませんでしょうか?
    Request Parameters の設定の場合には Content-Type の設定は不要ですので解除した上でお試しください。

    なお、Content-Type を application/json に設定の上、Body に記載する方法でも使用は可能です。

    2019.09.30

    0
  • 理解しました。ありがとうございました。

    2019.10.01

    0