スペースのメンバーを更新する

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

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

HTTPメソッド	PUT
URL	https://sample.cybozu.com/k/v1/space/members.json
URL（ゲストスペース）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/space/members.json
認証	パスワード認証 , セッション認証 , OAuth認証
Content-Type	application/json

リクエストパラメーター

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

パラメーター名	型	必須	説明
id	数値または文字列	必須	メンバー情報を更新するスペースのスペースID
members	配列	必須	スペースのメンバーの情報の配列スペース管理者を1名以上設定していない場合、もしくは次のユーザーのいずれかを指定した場合、エラーが発生します。 kintoneを利用していないユーザー使用停止中のユーザー削除したユーザー
members[].entity	オブジェクト	必須	スペースのメンバーの情報ゲストメンバーは指定できません。
members[].entity.type	文字列	必須	スペースのメンバーの種類次の値を指定できます。 `USER`：ユーザー `GROUP`：グループ `ORGANIZATION`：組織
members[].entity.code	文字列	必須	スペースのメンバーのコード
members[].isAdmin	真偽値または文字列	条件必須	メンバーをスペース管理者にするかどうか `true`：スペース管理者にする場合 `false`：スペース管理者にしない場合省略すると「false」が設定されます。スペース管理者を1名以上指定していない場合、エラーが発生します。
members[].includeSubs	真偽値または文字列	省略可	下位組織を含むかどうか `true`：下位組織を含める場合 `false`：下位組織を含めない場合 `entity.type`が「ORGANIZATION」のときのみ有効です。省略すると「false」が設定されます。

レスポンスプロパティ

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

なし

必要なアクセス権

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

スペース管理者

サンプル

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

サンプルリクエスト

リクエストヘッダー

1
2
3
4


{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

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

リクエストボディ

 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


{
  "id": 1,
  "members": [
    {
      "entity": {
        "type": "USER",
        "code": "user1"
      },
      "isAdmin": true
    },
    {
      "entity": {
        "type": "GROUP",
        "code": "group1"
      },
      "isAdmin": false
    },
    {
      "entity": {
        "type": "ORGANIZATION",
        "code": "org1"
      },
      "isAdmin": false,
      "includeSubs": true
    }
  ]
}

サンプルレスポンス

1

{}

サンプルコード

kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する

 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


const body = {
  id: 1,
  members: [
    {
      entity: {
        type: 'USER',
        code: 'user1'
      },
      isAdmin: true
    },
    {
      entity: {
        type: 'GROUP',
        code: 'group1'
      },
      isAdmin: false
    },
    {
      entity: {
        type: 'ORGANIZATION',
        code: 'org1'
      },
      isAdmin: false,
      includeSubs: true
    }
  ]
};

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

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

 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


curl -X PUT 'https://sample.cybozu.com/k/v1/space/members.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "1",
    "members": [
      {
        "entity": {
          "type": "USER",
          "code": "user1"
        },
        "isAdmin": "true"
      },
      {
        "entity": {
          "type": "GROUP",
          "code": "group1"
        },
        "isAdmin": "false"
      },
      {
        "entity": {
          "type": "ORGANIZATION",
          "code": "org1"
        },
        "isAdmin": "false",
        "includeSubs": "true"
      }
    ]
  }'

補足

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

スペース機能を利用していない場合には、エラーが発生します。
ゲストスペース機能が無効の場合に、ゲストスペースを更新しようとするとエラーが発生します。
ゲストメンバーの設定は更新できません。

kintone API

kintone APIドキュメント

スペースのメンバーを更新する

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル

補足