• 用户组操作
    • 获取用户组详情
    • 获取用户组列表
    • 创建用户组
    • 修改用户组
    • 删除用户组
    • 批量删除用户组

    用户组操作

    获取用户组详情

    接口

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

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

    代码示例

    1. var axios = require('axios').create({
    2. withCredentials: true
    3. })
    4. axios.get('https://cloud.minapp.com/userve/v1/user-group/47/').then(res => {
    5. console.log(res.data)
    6. })

    返回示例

    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/userve/v1/user-group/

    参数说明

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

    代码示例

    1. var axios = require('axios').create({
    2. withCredentials: true
    3. })
    4. axios.get('https://cloud.minapp.com/userve/v1/user-group/').then(res => {
    5. console.log(res.data)
    6. })

    创建用户组

    接口

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

    参数说明

    Content-Type: application/json

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

    代码示例

    1. var axios = require('axios').create({
    2. withCredentials: true
    3. })
    4. axios.post('https://cloud.minapp.com/userve/v1/user-group/', {name: 'User Group'}).then(res => {
    5. console.log(res.data)
    6. })

    状态码说明

    201 写入成功

    修改用户组

    接口

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

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

    代码示例

    1. var axios = require('axios').create({
    2. withCredentials: true
    3. })
    4. axios.put('https://cloud.minapp.com/userve/v1/user-group/47/', {name: 'user group'}).then(res => {
    5. console.log(res.data)
    6. })

    状态码说明

    200 修改成功

    删除用户组

    接口

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

    代码示例

    1. var axios = require('axios').create({
    2. withCredentials: true
    3. })
    4. axios.delete('https://cloud.minapp.com/userve/v1/user-group/47/').then(res => {
    5. console.log(res.data)
    6. })

    状态码说明

    204 删除成功

    批量删除用户组

    接口

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

    代码示例

    1. var axios = require('axios').create({
    2. withCredentials: true
    3. })
    4. axios.delete('https://cloud.minapp.com/userve/v1/user-group/', {
    5. params: {
    6. id__in: '48,50'
    7. }
    8. }).then(res => {
    9. console.log(res.data)
    10. })

    状态码说明

    204 删除成功