スペースのメンバーの取得

フォローする

スペースのメンバーの取得

スペースのメンバーとスペース管理者の情報を取得します。

  • スペース機能、ゲストスペース機能を利用していない場合にはエラーになります。
  • ゲストスペースでは、メンバーの取得のみになります。

HTTP メソッド

GET

URI

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

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

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

アクセス権

非公開スペースの場合、スペース参加者のみ実行可能です。

リクエストパラメータ

パラメータ名 指定する値 必須 説明
id 文字列 必須 メンバー情報を取得するスペースのIDを指定します。

リクエストの例

(1) パラメータを HTTP のクエリ文字列で送信する場合

「id」のパラメータをHTTPのクエリ文字列として送信します。

リクエストヘッダを含んだ文字列
GET /k/v1/space/members.json?id=1 HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
  • Content-Typeヘッダは不要です。

(2) パラメータを JSON形式で送信する場合(HTTP リクエストのリクエストボディに JSON データをセットする場合)

リクエストヘッダ
GET /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文字列をリクエストボディに載せて送ります。

レスポンス

パラメータ名 値の種類 説明
members 配列

スペースのメンバーの情報。 ※下記ユーザーはレスポンスに含まれません。

  • ゲストユーザー
  • 利用サービスにkintoneを選択していないユーザー
  • 使用停止中のユーザー
  • 削除したユーザー
members[].entity オブジェクト スペースのメンバーのエンティティ情報。
members[].entity.type 文字列 スペースのメンバーのエンティティの種類。 USER、GROUP、ORGANIZATION のいずれかとなります。
members[].entity.code 文字列 スペースのメンバーのエンティティのコード。
members[].isAdmin 真偽値 スペースのメンバーがスペース管理者かどうか。
true: スペース管理者
false: スペース管理者ではない
members[].isImplicit 真偽値

ユーザーとして追加されているかどうか。
true: ユーザーとして追加されていない (メンバーのグループ・組織に所属するユーザー)
false: ユーザーとして追加されている
※メンバーの組織に所属しているユーザーでも、ユーザーとして登録されていれば false となります。
※entityのtypeがUSER以外の場合はこの値は存在しません。

members[].includeSubs 真偽値 下位組織を含むかどうか。
true: 下位組織を含む
false: 下位組織を含まない
※entityのtypeがUSER以外の場合はこの値は存在しません。

JavaScriptサンプル

kintone REST API

XMLHttpRequest

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

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

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