kintone APIドキュメント

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

目次

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

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

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

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

URL

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

https://sample.cybozu.com/k/v1/guests.json

HTTPメソッド

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

DELETE

必要なアクセス権

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

  • kintoneシステム管理者

リクエスト

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

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

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}
ボディ
1
2
3

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

レスポンス

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

1

{}

サンプルコード

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

curlを使ったリクエスト
 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()を使ったリクエスト

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