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

目次

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

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

  • ゲストスペースでは、メンバーのみ取得できます。
  • スペース機能を利用していない場合には、エラーが発生します。
  • ゲストスペース機能が無効の場合に、ゲストスペースの情報を取得しようとするとエラーが発生します。

URL

https://sample.cybozu.com/k/v1/space/members.json

ゲストスペースの場合

https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/space/members.json

HTTPメソッド

GET

必要なアクセス権

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

リクエスト

パラメーター
パラメーター名 必須 説明
id 数値または文字列 必須 メンバー情報を取得するスペースのスペースID
リクエストの例(URLにパラメーターを含める場合)
URL

https://sample.cybozu.com/k/v1/space/members.json?app=1

ヘッダー
1
2
3
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

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

リクエストの例(リクエストボディにパラメーターを含める場合)
ヘッダー
1
2
3
4
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

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

ボディ
1
2
3
{
  "id": "1"
}

レスポンス

プロパティ
プロパティ名 説明
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」以外の場合は、このプロパティが存在しません。
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
  "members": [
    {
      "entity": {
        "type": "USER",
        "code": "user1"
      },
      "isAdmin": false,
      "isImplicit": true
    },
    {
      "entity": {
        "type": "USER",
        "code": "user2"
      },
      "isAdmin": true,
      "isImplicit": false
    },
    {
      "entity": {
        "type": "GROUP",
        "code": "group1"
      },
      "isAdmin": false
    },
    {
      "entity": {
        "type": "ORGANIZATION",
        "code": "org1"
      },
      "isAdmin": false,
      "includeSubs": true
    }
  ]
}

サンプルコード

curlを使ったリクエスト
1
2
3
4
5
6
curl -X GET 'https://sample.cybozu.com/k/v1/space/members.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 1
  }'
kintone REST APIリクエストを送信するAPIを使ったリクエスト
1
2
3
4
5
const body = {
  id: 1
};

await kintone.api(kintone.api.url('/k/v1/space/members.json', true), 'GET', body);