用户组操作

获取用户组详情

接口

GET https://cloud.minapp.com/oserve/v1/user-group/:group_id/

其中 :group_id 需替换为你的用户组 ID

代码示例

{% tabs userGroupDetailCurl=”Curl”, userGroupDetailNode=”Node”, userGroupDetailPHP=”PHP” %}

{% content “userGroupDetailCurl” %}

  1. curl -X GET \
  2. -H "Authorization: Bearer 58f6cd9f84b1b0c04941fbd4d87bc5f14a785107" \
  3. -H "Content-Type: application/json" \
  4. https://cloud.minapp.com/oserve/v1/user-group/47/

{% content “userGroupDetailNode” %}

  1. var request = require('request');
  3. var opt = {
  4.   uri: 'https://cloud.minapp.com/oserve/v1/user-group/655',  // 655 对应 :group_id
  5.   method: 'GET',
  6.   headers: {
  7.     Authorization: `Bearer ${token}`,
  8.   }
  9. }
  11. request(opt, function(err, res, body) {
  12.   console.log(body)
  13. })

{% content “userGroupDetailPHP”%}

  1. <?php
  2. $group_id = 47; // 用户组 ID
  3. $url = "https://cloud.minapp.com/oserve/v1/user-group/{$group_id}/";
  5. $ch = curl_init();
  6. $header = array(
  7.   "Authorization: Bearer {$token}",
  8.   'Content-Type: application/json; charset=utf-8'
  9. );
  11. curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
  12. curl_setopt($ch, CURLOPT_TIMEOUT, 30);
  13. curl_setopt($ch, CURLOPT_URL, $url);
  14. curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
  15. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  16. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
  18. $res = curl_exec($ch);
  19. curl_close($ch);

{% endtabs %}

返回示例

  1. {
  2.   "id": 47,
  3.   "members": 0,
  4.   "name": "User Group",
  5.   "parent": {
  6.     "id": 1,
  7.     "name": "Super Group"
  8.   }
  9. }

members 表示在用户组下的用户数量，parent 表示用户组的组集

获取用户组列表

接口

GET https://cloud.minapp.com/oserve/v1/user-group/

参数说明

参数 类型 必填 说明
parent_id String N 用户组的组集 ID
limit Number N 限制返回资源的个数，默认为 20 条，最大可设置为 1000
offset Number N 设置返回资源的起始偏移值，默认为 0

代码示例

{% tabs userGroupCurl=”Curl”, userGroupNode=”Node”, userGroupPHP=”PHP” %}

{% content “userGroupCurl” %}

  1. curl -X GET \
  2. -H "Authorization: Bearer 58f6cd9f84b1b0c04941fbd4d87bc5f14a785107" \
  3. -H "Content-Type: application/json" \
  4. -G \
  5. -d parent_id=1 \
  6. https://cloud.minapp.com/oserve/v1/user-group/

{% content “userGroupNode” %}

  1. var request = require('request');
  3. var opt = {
  4.   uri: 'https://cloud.minapp.com/oserve/v1/user-group/',
  5.   method: 'GET',
  6.   headers: {
  7.     Authorization: `Bearer ${token}`,
  8.   },
  9.   qs: {     // query string, 被附加到uri的参数
  10.     parent_id: "234565423456787645xx",   // 可选, 没有用户组的组集 ID, 可以设置为 null 或者不设置
  11.     offset: 0,         // 可选
  12.     limit: 20          // 可选
  13.   }
  14. }
  16. request(opt, function(err, res, body) {
  17.   console.log(body)
  18. })

{% content “userGroupPHP”%}

  1. <?php
  2. $query['parent_id'] = 1; // 用户组的组集 ID
  3. $query['offset'] = 0; // 资源的起始偏移值
  4. $query['limit'] = 20; // 限制返回资源的个数
  5. $query_string = http_build_query($query);
  6. $url = "https://cloud.minapp.com/oserve/v1/user-group/?".$query_string;
  8. $ch = curl_init();
  9. $header = array(
  10.   "Authorization: Bearer {$token}",
  11.   'Content-Type: application/json; charset=utf-8'
  12. );
  14. curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
  15. curl_setopt($ch, CURLOPT_TIMEOUT, 30);
  16. curl_setopt($ch, CURLOPT_URL, $url);
  17. curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
  18. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  19. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
  21. $res = curl_exec($ch);
  22. curl_close($ch);

{% endtabs %}

创建用户组

接口

POST https://cloud.minapp.com/oserve/v1/user-group/

参数说明

Content-Type: application/json

参数 类型 必填 说明
name String Y 用户组的名称
parent String N 组集 ID

代码示例

{% tabs createUserGroupCurl=”Curl”, createUserGroupNode=”Node”, createUserGroupPHP=”PHP” %}

{% content “createUserGroupCurl” %}

  1. curl -X POST \
  2. -H "Authorization: Bearer 58f6cd9f84b1b0c04941fbd4d87bc5f14a785107" \
  3. -H "Content-Type: application/json" \
  4. -d '{"name": "User Group"}' \
  5. https://cloud.minapp.com/oserve/v1/user-group/

{% content “createUserGroupNode” %}

  1. var request = require('request');
  3. var opt = {
  4.   uri: 'https://cloud.minapp.com/oserve/v1/user-group/',
  5.   method: 'POST',
  6.   headers: {
  7.     Authorization: `Bearer ${token}`,
  8.   },
  9.   json: {   // 指定 data 以 "Content-Type": 'application/json' 传送
  10.     name: 'testGroup'
  11.   }
  12. }
  14. request(opt, function(err, res, body) {
  15.   console.log(res.statusCode, body)
  16. })

{% content “createUserGroupPHP” %}

  1. <?php
  2. $param = array(
  3.   'name' =>'User Group'
  4. );
  5. $url = 'https://cloud.minapp.com/oserve/v1/user-group/';
  7. $ch = curl_init();
  8. $header = array(
  9.   "Authorization: Bearer {$token}",
  10.   'Content-Type: application/json; charset=utf-8'
  11. );
  13. curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
  14. curl_setopt($ch, CURLOPT_TIMEOUT, 30);
  15. curl_setopt($ch, CURLOPT_URL, $url);
  16. curl_setopt($ch, CURLOPT_POST, true);
  17. curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
  18. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  19. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
  21. $res['response'] = curl_exec($ch); // 反馈结果
  22. $res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 返回状态码
  23. curl_close($ch);

{% endtabs %}

状态码说明

201 写入成功

修改用户组

接口

PUT https://cloud.minapp.com/oserve/v1/user-group/:group_id/

其中 :group_id 需替换为你的用户组 ID

代码示例

{% tabs updateGroupCurl=”Curl”, updateGroupNode=”Node”, updateGroupPHP=”PHP” %}

{% content “updateGroupCurl” %}

  1. curl -X PUT \
  2. -H "Authorization: Bearer 58f6cd9f84b1b0c04941fbd4d87bc5f14a785107" \
  3. -H "Content-Type: application/json" \
  4. -d '{"name": "user group"}' \
  5. https://cloud.minapp.com/oserve/v1/user-group/47/

{% content “updateGroupNode” %}

  1. var request = require('request');
  3. var opt = {
  4.   uri: 'https://cloud.minapp.com/oserve/v1/user-group/655/',  // 655 对应 :group_id
  5.   method: 'PUT',
  6.   headers: {
  7.     Authorization: `Bearer ${token}`,
  8.   },
  9.   json: {   // 指定 data 以 "Content-Type": 'application/json' 传送
  10.     name: 'testGroup_3'   // 修改后的用户组名
  11.   }
  12. }
  14. request(opt, function(err, res, body) {
  15.   console.log(res.statusCode)
  16. })

{% content “updateGroupPHP” %}

  1. <?php
  2. $group_id = 47; // 用户组 ID
  3. $url = "https://cloud.minapp.com/oserve/v1/user-group/{$group_id}/";
  4. $param = array(
  5.   'name' =>'user group'
  6. );
  8. $ch = curl_init();
  9. $header = array(
  10.   "Authorization: Bearer {$token}",
  11.   'Content-Type: application/json; charset=utf-8'
  12. );
  14. curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
  15. curl_setopt($ch, CURLOPT_TIMEOUT, 30);
  16. curl_setopt($ch, CURLOPT_URL, $url);
  17. curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
  18. curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($param));
  19. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  20. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
  22. $res['response'] = curl_exec($ch); // 反馈结果
  23. $res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 状态码
  24. curl_close($ch);

{% endtabs %}

状态码说明

200 修改成功

删除用户组

接口

DELETE https://cloud.minapp.com/oserve/v1/user-group/:group_id/

代码示例

{% tabs deleteGroupCurl=”Curl”, deleteGroupNode=”Node”, deleteGroupPHP=”PHP” %}

{% content “deleteGroupCurl” %}

  1. curl -X DELETE \
  2. -H "Authorization: Bearer 58f6cd9f84b1b0c04941fbd4d87bc5f14a785107" \
  3. -H "Content-Type: application/json" \
  4. https://cloud.minapp.com/oserve/v1/user-group/47/

{% content “deleteGroupNode” %}

  1. var request = require('request');
  3. var opt = {
  4.   uri: 'https://cloud.minapp.com/oserve/v1/user-group/655/',  // 655 对应 :group_id
  5.   method: 'DELETE',
  6.   headers: {
  7.     Authorization: `Bearer ${token}`,
  8.   }
  9. }
  11. request(opt, function(err, res, body) {
  12.   console.log(res.statusCode)
  13. })

{% content “deleteGroupPHP” %}

  1. <?php
  2. $group_id = 47; // 用户组 ID
  3. $url = "https://cloud.minapp.com/oserve/v1/user-group/{$group_id}/";
  5. $ch = curl_init();
  6. $header = array(
  7.   "Authorization: Bearer {$token}",
  8.   'Content-Type: application/json; charset=utf-8'
  9. );
  11. curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
  12. curl_setopt($ch, CURLOPT_TIMEOUT, 30);
  13. curl_setopt($ch, CURLOPT_URL, $url);
  14. curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
  15. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  16. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
  18. $res['response'] = curl_exec($ch); // 反馈结果
  19. $res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 请求状态码
  20. curl_close($ch);

{% endtabs %}

状态码说明

204 删除成功

批量删除用户组

接口

DELETE https://cloud.minapp.com/oserve/v1/user-group/?id__in=:group_id,group1_id

代码示例

{% tabs patchDeleteGroupCurl=”Curl”, patchDeleteGroupNode=”Node”, patchDeleteGroupPHP=”PHP” %}

{% content “patchDeleteGroupCurl” %}

  1. curl -X DELETE \
  2. -H "Authorization: Bearer 58f6cd9f84b1b0c04941fbd4d87bc5f14a785107" \
  3. -H "Content-Type: application/json" \
  4. https://cloud.minapp.com/oserve/v1/user-group/?id__in=48,50

{% content “patchDeleteGroupNode” %}

  1. var request = require('request');
  3. var opt = {
  4.   uri: 'https://cloud.minapp.com/oserve/v1/user-group/?id__in=652,653',  // id__in=652,653 对应 id__in=:group_id,group1_id
  5.   method: 'DELETE',
  6.   headers: {
  7.     Authorization: `Bearer ${token}`,
  8.   }
  9. }
  11. request(opt, function(err, res, body) {
  12.   console.log(res.statusCode)
  13. })

{% content “patchDeleteGroupPHP” %}

  1. <?php
  2. // 用户组 ID 集
  3. $group_id[] = 48;
  4. $group_id[] = 50; 
  5. $url = 'https://cloud.minapp.com/oserve/v1/user-group/?'.implode(',',$group_id);
  7. $ch = curl_init();
  8. $header = array(
  9.   "Authorization: Bearer {$token}",
  10.   'Content-Type: application/json; charset=utf-8'
  11. );
  13. curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
  14. curl_setopt($ch, CURLOPT_TIMEOUT, 30);
  15. curl_setopt($ch, CURLOPT_URL, $url);
  16. curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
  17. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  18. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
  20. $res['response'] = curl_exec($ch); // 反馈结果
  21. $res['status_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE); // 请求状态码
  22. curl_close($ch);

{% endtabs %}

状态码说明

204 删除成功