批量设置用户席位

POST

/sdk/v2/api/license/users/set-status

提示

由于“App 管理”相关的接口的特殊性，为了安全考虑，需要在生成签名时附加上 "scope": "license" 字段。

说明

设置为 -1 未启用 并不能阻止用户继续使用石墨 SDK，比如用户打开的石墨 SDK 页面并没有关闭，signature 和 token 仍有效，即使设置为 -1 未启用，只要用户未关闭的页面发起了请求，状态也会被自动设置为 1 激活。

请求参数

Header 参数

X-Shimo-Signature

string

必需

示例值:

X-Shimo-Token

string

必需

示例值:

Body 参数application/json

userIds

array[string]

必需

需修改席位状态的用户 ID 列表

status

number

必需

1激活，0 禁用，-1 未启用，详见用户席位说明

示例

{
  "userIds": [
    "1",
    "2"
  ],
  "status": 1
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://office.shimoapi.com/sdk/v2/api/license/users/set-status' \
--header 'X-Shimo-Signature: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImZkZWEwODk5NTYwMzRkMzliOWZjYmZmOTg1M2NhYWZiIn0.eyJleHAiOjE3NDAwMTk1MDF9.wBfjvKigaNDeRldcKlJLr6FFHRGw50q7RYfuYb7Jy5U' \
--header 'X-Shimo-Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImZkZWEwODk5NTYwMzRkMzliOWZjYmZmOTg1M2NhYWZiIn0.eyJ1c2VySWQiOjQ5LCJtb2RlIjoic2hpbW8iLCJleHAiOjE3NDAwMTk1MDF9.Ta124wvF-lbpge6Ytah-7LyasBfu0SnZgDyu3GuwXDM' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userIds": [
        "1",
        "2"
    ],
    "status": 1
}'

返回响应

🟢204成功

text/plain

Body

object {0}

取消用户席位

创建协同文档