文档首页> 应用与数据集成平台 ROMA Connect> API参考> 公共资源API> 应用管理> 设置用户成员
更新时间：2023-11-29 GMT+08:00
在线调试
CLI示例
查看PDF

设置用户成员

功能介绍

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

app_id

是

String

应用ID。

instance_id

是

String

实例ID。

project_id

是

String

项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

users

否

Array of User objects

要添加的用户成员列表，空列表时代表清空应用的所有成员。
表4 User

参数

是否必选

参数类型

描述

id

否

String

用户ID。

roles

否

Array of strings

应用权限角色。

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

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

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

  • modify：应用下资源的修改权限，包括API发布、下线。

  • admin：应用和应用下资源的权限。

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

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

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

total

Integer

应用的总成员数量。

id

String

应用ID。

users

Array of users objects

用户成员列表。
表6 users

参数

参数类型

描述

id

String

用户ID。

name

String

用户名称。

roles

Array of strings

应用权限角色。

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

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

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

  • modify：应用下资源的修改权限，包括API发布、下线。

  • admin：应用和应用下资源的权限。

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

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

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

error_details

String

具体错误消息。

request_id

String

请求处理ID。

请求示例

为集成应用设置授权的用户和用户权限。

{
  "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" ]
  } ]
}

状态码： 403

Forbidden

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

状态码

状态码

描述

200

OK

403

Forbidden

错误码

请参见错误码。

父主题： 应用管理