ゲストユーザーを削除する

固定リンクがコピーされました

ゲストユーザーをkintoneから削除します。

HTTPメソッド	DELETE
URL	https://sample.cybozu.com/k/v1/guests.json
認証	パスワード認証 , セッション認証 , OAuth認証
Content-Type	application/json

リクエストパラメーター

固定リンクがコピーされました

パラメーター名	型	必須	説明
guests	配列（文字列）	必須	削除するゲストユーザーのメールアドレスの一覧最大で100件のメールアドレスを指定できます。

レスポンスプロパティ

固定リンクがコピーされました

なし

必要なアクセス権

固定リンクがコピーされました

kintoneシステム管理者

サンプル

固定リンクがコピーされました

サンプルリクエスト

リクエストヘッダー

1
2
3
4


{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様

リクエストボディ

1
2
3


{
  "guests": ["guest1@example.com", "guest2@example.com", "guest3@example.com"]
}

サンプルレスポンス

1

{}

サンプルコード

kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する

1
2
3
4
5
6
7
8
9


const body = {
  guests: [
    'guest1@example.com',
    'guest2@example.com',
    'guest3@example.com'
  ]
};

await kintone.api(kintone.api.url('/k/v1/guests.json', true), 'DELETE', body);

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


curl -X DELETE 'https://sample.cybozu.com/k/v1/guests.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "guests": [
      "guest1@example.com",
      "guest2@example.com",
      "guest3@example.com"
    ]
  }'

補足

固定リンクがコピーされました

スペース機能やゲストスペース機能が無効の場合でも実行できます。
ゲストスペースからの退会ではなく、kintoneからゲストユーザーの情報が削除されます。
ゲストスペースから退会する場合には、ゲストスペースのゲストメンバーを更新するAPIでゲストスペースから削除してください。
ゲストスペースのゲストメンバーを更新するAPI

kintone API

kintone APIドキュメント

ゲストユーザーを削除する

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル

補足