更新时间:2022-12-05 GMT+08:00

设置用户成员

功能介绍

  • 设置应用的用户成员,为空数组时会清空已有应用成员列表

  • 设置动作为全量更新非增量更新,应用的成员列表都会替换为当次请求的应用成员列表

URI

PUT /v2/{project_id}/instances/{instance_id}/apps/{app_id}/users

表1 路径参数

参数

是否必选

参数类型

描述

app_id

String

应用ID

最小长度:0

最大长度:64

instance_id

String

实例ID

最小长度:0

最大长度:64

project_id

String

项目ID

最小长度:0

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

最小长度:1

最大长度:100000

表3 请求Body参数

参数

是否必选

参数类型

描述

users

Array of strings

要添加的用户成员列表,空列表时代表清空应用的所有成员

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

应用的总成员数量

最小值:1

最大值:5

id

String

应用ID

users

Array of users objects

用户成员列表

表5 users

参数

参数类型

描述

id

String

用户ID

name

String

用户名称

roles

Array of strings

应用权限角色

  • read:应用下资源只读权限,至少要存在此权限,包括API调试

  • access:应用下资源的访问管理权限

  • delete:应用下资源的删除权限

  • modify:应用下资源的修改权限,包括API发布、下线

  • admin:应用和应用下资源的权限

  • 仅提供admin时,会自动应用其它所有权限

  • 未提供read时会自动应用read权限

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:128

error_details

String

具体错误消息

最小长度:1

最大长度:128

request_id

String

请求处理ID

最小长度:1

最大长度:128

suggestion

String

处理建议

最小长度:1

最大长度:128

请求示例

{
  "users" : [ {
    "id" : "06d9106f3b000f241f83c010d6b78c81",
    "roles" : [ "read" ]
  } ]
}

响应示例

状态码: 200

OK

{
  "total" : 1,
  "id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3",
  "users" : [ {
    "id" : "string",
    "name" : "string",
    "roles" : [ "read, access, delete, modify, admin" ]
  } ]
}

状态码: 400

Bad Request

{
  "error_code" : "ROMA.00000101",
  "error_msg" : "error summary",
  "error_details" : "some error details here",
  "suggestion" : "some suggestion",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码