スペースのメンバーの更新

フォローする

スペースのメンバーの更新

スペースのメンバーとスペース管理者の設定を指定した内容で更新します。

  • スペース機能を利用していない場合にはエラーになります。
  • ゲストスペース機能を利用していない場合にはエラーになります。
  • ゲストメンバーの設定は更新できません。

HTTP メソッド

PUT

URI

https://(サブドメイン名).cybozu.com/k/v1/space/members.json

ゲストスペース内のアプリの場合

https://(サブドメイン名).cybozu.com/k/guest/<ゲストスペースのID>/v1/space/members.json

アクセス権

スペースの管理者のみ実行可能です。

リクエストパラメータ

パラメータ名 指定する値 必須 説明
id 文字列 必須 メンバー情報を更新するスペースのIDを指定します。
members 配列 必須 スペースのメンバーの情報を配列で指定します。
※スペース管理者を1名以上含まない場合、もしくは下記ユーザーのいずれかを指定した場合、エラーになります。
  • 利用サービスにkintoneを選択していないユーザー
  • 使用停止中のユーザー
  • 削除したユーザー
members[].entity オブジェクト 必須 スペースのメンバーのエンティティ情報。 ゲストメンバーは指定できません。
members[].entity.type 文字列 必須 スペースのメンバーのエンティティの種類。 USER、GROUP、ORGANIZATION のいずれかを指定します。
members[].entity.code 文字列 必須 スペースのメンバーのエンティティのコードを指定します。
members[].isAdmin 真偽値又は文字列 条件必須

メンバーをスペース管理者にするか指定します。 省略時はfalseとなります。
true: スペース管理者
false: スペース管理者ではない

※スペース管理者を1名以上含まない場合、エラーとなります。

members[].includeSubs 真偽値又は文字列   下位組織を含むかどうか指定します。 entityのtypeがORGANIZATIONのときのみ有効です。 省略時はfalseとなります。
true: 下位組織を含める
false: 下位組織を含めない

リクエストの例

HTTPリクエストのリクエストボディに JSON データをセットする例は以下の通りです。

リクエストヘッダ
PUT /k/v1/space/members.json HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json
  • Content-Type に application/json を指定して下さい。 指定しない場合は JSON が解釈できないため、実行時エラーとなります。
ボディ
  • JSON文字列をリクエストボディに載せて送ります。

レスポンス

処理成功時は空の JSON データが返されます。

JavaScriptサンプル

kintone REST API

XMLHttpRequest

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。
Powered by Zendesk