获取项目成员设置
功能介绍
获取项目成员设置
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/projects/{project_id}/member-setting
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口查询项目列表获取。 取值范围: 字符串长度32。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
参数解释: 偏移量,从0开始。 取值范围: 0-2147483647 默认取值: 0 |
limit |
否 |
Integer |
参数解释: 返回数量。 取值范围: 1-100 默认取值: 20 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
product_id |
String |
参数解释: 项目id 取值范围: 字符串长度不少于1,不超过1000。 |
sync_enabled |
Boolean |
参数解释: 同步开关 |
sync_all_role_enabled |
Boolean |
参数解释: 同步所有角色开关 |
role_sync |
Array of RoleSyncDto objects |
参数解释: 角色同步 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
参数解释: 角色记录id。 取值范围: 1-2147483647 |
role_id |
String |
参数解释: 角色id。 取值范围: 字符串长度不少于1,不超过1000。 |
role_sync_enabled |
Boolean |
参数解释: 角色同步开关。 |
role_name |
String |
参数解释: 角色名称。 取值范围: 字符串长度不少于1,不超过1000。 |
role_type |
String |
参数解释: 角色类型。 取值范围: 字符串长度不少于1,不超过1000。 |
role_chinese_name |
String |
参数解释: 角色中文名称。 取值范围: 字符串长度不少于1,不超过1000。 |
created_at |
String |
参数解释: 创建时间。 取值范围: 字符串长度不少于1,不超过1000。 |
updated_at |
String |
参数解释: 更新时间。 取值范围: 字符串长度不少于1,不超过1000。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
GET https://{endpoint}/v4/projects/{project_id}/member-setting?offset=1&limit=20
响应示例
状态码:200
获取项目成员设置
{ "product_id" : "66d26441a9a24158af9db7603f1e0937", "sync_enabled" : true, "role_sync" : [ { "id" : 11588179, "role_id" : "d4b6fd9af7e34b168de2fef683058f13", "role_sync_enabled" : true, "role_name" : "Project manager", "role_type" : "template-customized-inst", "role_chinese_name" : "项目经理", "created_at" : 1745289920273, "updated_at" : 1745289920273 }, { "id" : 11588178, "role_id" : "f7b9f99aa0d94dc595aef01d2ed661a9", "role_sync_enabled" : false, "role_name" : "Product manager", "role_type" : "template-customized-inst", "role_chinese_name" : "产品经理", "created_at" : 1745289920268, "updated_at" : 1745289920268 } ] }
状态码:401
Unauthorized
{ "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }
状态码:403
Bad Request
{ "error_code" : "CH.004403", "error_msg" : "您没有操作权限,请升级权限后重试。" }
状态码:404
Not Found
{ "error_code" : "CH.004404", "error_msg" : "Group Not Found。Group Not Found" }
状态码
状态码 |
描述 |
---|---|
200 |
获取项目成员设置 |
401 |
Unauthorized |
403 |
Bad Request |
404 |
Not Found |
错误码
请参见错误码。