スペースの設定を変更する

目次

caution
警告

このページで説明している API は、開発を検討中の API です。

アップデートオプション内の「開発中の新機能」から動作をお試しいただけます。 設定方法は、 新機能の有効/無効の切り替え手順 (External link) を参照してください。

API に関するフィードバックを、ユースケースとともに、 kintone の改善に協力する (External link) フォームへぜひご登録ください。

フィードバックの例
  • API ラボで提供されている API を早く本番環境で利用したい
  • こういう用途で使うために、このような API を提供してほしい

スペースの設定を変更する

スペースの設定を変更します。

利用するには開発中の新機能の「スペースの設定を変更する REST API」を有効にしてください。

URL

通常のスペース
https://sample.cybozu.com/k/v1/space.json
ゲストスペース
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/space.json

HTTP メソッド

PUT

必要なアクセス権

  • スペース管理権限

リクエスト

パラメーター
パラメーター名 必須 説明
id 文字列 必須 スペース ID
name 文字列 省略可 スペース名
指定されていない場合は更新しない。
isPrivate 真偽値 省略可 非公開スペースに更新するかどうか
  • true:非公開スペース
  • false:公開スペース

指定されていない場合は更新しない。
fixedMember 真偽値 省略可 各ユーザーがスペースの退会/アンフォローすることを禁止するかどうか
  • true:禁止する
  • false:禁止しない

指定されていない場合は更新しない。
useMultiThread 真偽値 省略可 マルチスレッドスペースに更新するかどうか
  • true:マルチスレッドスペース

falseまたは、指定されていない場合は更新しない。
showAnnouncement 真偽値 省略可 マルチスレッドスペースのポータルの「お知らせ」を表示するかどうか
  • true:表示する
  • false:表示しない
showThreadList 真偽値 省略可 マルチスレッドスペースのポータルの「スレッド一覧」を表示するかどうか
  • true:表示する
  • false:表示しない
showAppList 真偽値 省略可 マルチスレッドスペースのポータルの「アプリ一覧」を表示するかどうか
  • true:表示する
  • false:表示しない
showMemberList 真偽値 省略可 マルチスレッドスペースのポータルの「ピープル一覧」を表示するかどうか
  • true:表示する
  • false:表示しない
showRelatedLinkList 真偽値 省略可 マルチスレッドスペースのポータルの「関連リンク一覧」を表示するかどうか
  • true:表示する
  • false:表示しない
permissions オブジェクト 省略可 スペースに関する権限
permissions.createApp 文字列 省略可 アプリを作成できるユーザー
  • EVERYONE:すべてのユーザー
  • ADMIN:スペースの管理者

指定されていない場合は更新しない。
リクエストの例
ヘッダー
1
2
3
4
{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}
ボディ
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "id": 123,
  "name": "スペース名",
  "isPrivate": true,
  "fixedMember": true,
  "useMultiThread": true,
  "showAnnouncement": true,
  "showThreadList": true,
  "showAppList": true,
  "showMemberList": true,
  "showRelatedLinkList": true
  "permissions": {
    "createApp": "EVERYONE"
  }
}

レスポンス

1
{}