契约锁 API

组织架构-管理员工角色

POST

/v2/role/manage

管理员工角色。

请求参数

Header 参数

x-qys-open-accesstoken

string

可选

默认值:

x-qys-open-timestamp

string

可选

默认值:

x-qys-open-nonce

string

可选

默认值:

x-qys-open-signature

string

可选

默认值:

Body 参数application/json

tenantName

string

子公司名称

可选

用于管理子公司下的角色，不指定此参数时表示管理平台方的角色

role

enum<string>

角色成员

必需

SEAL_ADMIN（“印章管理员”），TEMPLATE_ADMIN（“模板管理员”）

枚举值:

SEAL_ADMINTEMPLATE_ADMIN

operate

enum<string>

操作方式

可选

ADD（“添加”），REMOVE（“移除”），默认为添加

枚举值:

ADDREMOVE

users

array [object {2}]

编辑的成员列表

必需

必须为已注册的企业员工

contact

string

联系方式

必需

contactType

enum<string>

联系类型

必需

MOBILE（手机号），EMAIL（邮箱），EMPLOYEEID（员工ID），NUMBER（员工编号），BIZID（用户在对接方系统的唯一标识）

枚举值:

MOBILEEMAILEMPLOYEEIDNUMBERBIZID

示例

{
  "role": "TEMPLATE_ADMIN",
  "operate": "ADD",
  "users": [
    {
      "contact": "{{mobile}}",
      "contactType": "MOBILE"
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://openapi.qiyuesuo.com/v2/role/manage' \
--header 'x-qys-open-accesstoken: {{x-qys-open-accesstoken}}' \
--header 'x-qys-open-timestamp: {{x-qys-open-timestamp}}' \
--header 'x-qys-open-nonce: {{x-qys-open-nonce}}' \
--header 'x-qys-open-signature: {{x-qys-open-signature}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "role": "TEMPLATE_ADMIN",
    "operate":"ADD",
    "users": [
        {
            "contact": "{{mobile}}",
            "contactType": "MOBILE"
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

示例

{
  "code": 0,
  "message": "SUCCESS"
}

组织架构-员工详情

组织架构-移除员工