1.0.0

用户

创建用户

接口

POST <SHIMO_API>/users

在申请 Access Token 的时候，石墨会判断传入的 clientUserId 是否已存在于系统中，若不存在，会自动创建一个用户，因此无需调用此接口创建用户。

鉴权信息

参数说明
scope"write user:create"

参数说明

参数类型必填说明
nameStringY用户名
emailStringY用户邮箱
avatarStringN用户头像
genderNumberN用户性别
clientUserIdStringY用户对应的 clientUserId

代码示例

const request = require('node-fetch')

fetch('<SHIMO_API>/users', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <Access Token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '墨客',
    email: 'example@shimo.im',
    clientUserId: 1
  })
})
  .then(res => res.json())
  .then(body => console.log(body.data))

返回示例

{
  "id": 1,
  "name": "墨客",
  "namePinyin": null,
  "email": "shimo@shimo.im",
  "avatar": null,
  "status": 0,
  "createdAt": "2018-06-01T07:45:15.000Z",
  "updatedAt": "2018-06-01T08:33:59.000Z"
}

获取用户列表

接口

GET <SHIMO_API>/users

鉴权信息

参数说明
scope"read"

参数说明

参数类型必填说明
idsNumber[]Y用户 ID 数组。clientUserIds 存在时可为空。
clientUserIdsString[]YClient user ID 数组。ids 存在时可为空。
sizeNumberN单次获取的数量
pageNumberN从第几页

代码示例

const request = require('node-fetch')

fetch('<SHIMO_API>/users', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <Access Token>',
    'Content-Type': 'application/json'
  }
})
  .then(res => res.json())
  .then(body => console.log(body.data))

返回示例

[{
  "id": 1,
  "name": "墨客",
  "namePinyin": null,
  "email": "shimo@shimo.im",
  "avatar": null,
  "status": 0,
  "createdAt": "2018-06-01T07:45:15.000Z",
  "updatedAt": "2018-06-01T08:33:59.000Z"
}]

获取用户

接口

GET <SHIMO_API>/users/:id

GET <SHIMO_API>/users/email?email=

GET <SHIMO_API>/users/client_user_id?client_user_id=

鉴权信息

参数说明
scope"read"

参数说明

参数类型必填说明
emailStringY用户邮箱
client_user_idStringY客户系统的用户标识

代码示例

const request = require('node-fetch')

fetch('<SHIMO_API>/users/email?email=example@shimo.im', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer <Access Token>',
    'Content-Type': 'application/json'
  }
})
  .then(res => res.json())
  .then(body => console.log(body.data))

返回示例

{
  "id": 1,
  "name": "墨客",
  "namePinyin": null,
  "email": "shimo@shimo.im",
  "avatar": null,
  "status": 0,
  "createdAt": "2018-06-01T07:45:15.000Z",
  "updatedAt": "2018-06-01T08:33:59.000Z"
}

修改用户信息

接口

PATCH <SHIMO_API>/users/me

PATCH <SHIMO_API>/users/client_user_id?clientUserId=

PATCH <SHIMO_API>/users/:id

使用 me 时等同于当前登录用户的 id。

使用 client_user_id 则以 clientUserId 查找登录用户，用于第三方集成时使用。

鉴权信息

参数说明
scope"write"

参数说明

参数类型必填说明
nameStringN用户名
emailStringN用户邮箱
avatarStringN用户头像
genderNumberN用户性别

代码示例

const request = require('node-fetch')

fetch('<SHIMO_API>/users/me', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <Access Token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '石墨文档'
  })
})
  .then(res => res.json())
  .then(body => console.log(body.data))

返回示例

{
  "id": 1,
  "name": "石墨文档",
  "namePinyin": null,
  "email": "shimo@shimo.im",
  "avatar": null,
  "status": 0,
  "createdAt": "2018-06-01T07:45:15.000Z",
  "updatedAt": "2018-06-01T08:33:59.000Z"
}
← 上一页