注意:以下文档只适用于TOP接口,请谨慎使用!

文档中心 > API类目 > MOZI权限API

alibaba.mozi.acl.role.add (新增一个角色)

新增一个角色

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
create_role_request CreateRoleRequest 必须 创建角色请求对象
  • └ target_app_name
  • String
  • 可选
  • buc
  • 角色归属的应用name,不传则以appKey对应的应用为准
  • └ add_permission_names
  • String []
  • 可选
  • summer_test_top_permission_01
  • 角色包含的权限name列表
  • └ description
  • String
  • 必须
  • top_test
  • 角色描述
  • └ title
  • String
  • 必须
  • 测试top角色
  • 角色中文名称
  • └ type
  • String
  • 可选
  • null
  • 角色类型,重点注意:如果创建租户内角色,则必须填“Realm_Role”,ISV开发者创建应用侧角色,则可不填
  • └ request_meta_data
  • String
  • 可选
  • {""}
  • 请求扩展字段
  • └ data_permission_json_str
  • String
  • 可选
  • {""}
  • 角色包含的数据权限,以json传入
  • └ title_e_n
  • String
  • 必须
  • top_test
  • 角色英文名称
  • └ is_data
  • Boolean
  • 可选
  • false
  • 是否数据权限,角色没有挂载数据权限,则为false
  • └ rule_type
  • String
  • 可选
  • random
  • 角色审批规则类型(random、self 两种类型)
  • └ public_attri
  • String
  • 可选
  • 1
  • 角色申请规则(1表示公开可申请,2表示公开不可申请、3表示不公开)
  • └ assign_level
  • String
  • 可选
  • L
  • 风险等级:L表示低风险,M表示中风,H表示高风险
  • principal_param
  • BucUserPrincipalParam
  • 必须
  • 操作主体
  • └ tenant_id
  • Number
  • 必须
  • 10000
  • 操作主体所在的租户Id
  • └ user_id
  • Number
  • 必须
  • 111411201
  • 操作人的userId
  • └ operator_user_id
  • Number
  • 可选
  • 111411201
  • 操作人的userId
  • └ name
  • String
  • 必须
  • summer_test_top_role_01
  • 角色唯一code,在ACL中全局唯一
  • └ owner_user_id
  • Number
  • 可选
  • 111411201
  • 角色归属人userId
  • └ revoke_rule
  • String
  • 必须
  • REVOKE
  • 角色回收策略(REVOKE代表用户所在部门发生变化时,该用户的权限将被回收,RESERVE代表用户所在部门发生变化时,该用户的权限将被保留,TRANSFER_REVOKE代表个人主动转岗时回收 - 只在小二主动申请转岗时回收本权限)
  • └ approver_user_ids
  • String []
  • 可选
  • 111411201
  • 角色审批人userId列表
  • └ extention_map
  • String
  • 可选
  • null
  • 扩展字段

响应参数

名称 类型 示例值 描述
result CreateRoleResult {""} 创建角色结果对象
  • └ data
  • String
  • ""
  • 创建角色返回data,此处无数据返回
  • └ success
  • Boolean
  • true
  • 接口调用是否成功,若成功则为true
  • └ request_id
  • String
  • sacwevdacqd32dec
  • 请求唯一id
  • └ response_message
  • String
  • 成功
  • 响应message,若失败则返回失败原因
  • └ response_meta_data
  • String
  • {""}
  • 扩展字段,与入参扩展字段值相同
  • └ response_code
  • String
  • 0
  • 响应code

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaMoziAclRoleAddRequest req = new AlibabaMoziAclRoleAddRequest();
AlibabaMoziAclRoleAddRequest.CreateRoleRequest obj1 = new AlibabaMoziAclRoleAddRequest.CreateRoleRequest();
obj1.setTargetAppName("buc");
obj1.setAddPermissionNames("summer_test_top_permission_01");
obj1.setDescription("top_test");
obj1.setTitle("测试top角色");
obj1.setType("null");
obj1.setRequestMetaData("{\"\"}");
obj1.setDataPermissionJsonStr("{\"\"}");
obj1.setTitleEN("top_test");
obj1.setIsData(false);
obj1.setRuleType("random");
obj1.setPublicAttri("1");
obj1.setAssignLevel("L");
AlibabaMoziAclRoleAddRequest.BucUserPrincipalParam obj2 = new AlibabaMoziAclRoleAddRequest.BucUserPrincipalParam();
obj2.setTenantId(10000L);
obj2.setUserId(111411201L);
obj1.setPrincipalParam(obj2);
obj1.setOperatorUserId(111411201L);
obj1.setName("summer_test_top_role_01");
obj1.setOwnerUserId(111411201L);
obj1.setRevokeRule("REVOKE");
obj1.setApproverUserIds("111411201");
obj1.setExtentionMap("null");
req.setCreateRoleRequest(obj1);
AlibabaMoziAclRoleAddResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_mozi_acl_role_add_response>
    <result>
        <data>&quot;&quot;</data>
        <success>true</success>
        <request_id>sacwevdacqd32dec</request_id>
        <response_message>成功</response_message>
        <response_meta_data>{&quot;&quot;}</response_meta_data>
        <response_code>0</response_code>
    </result>
</alibaba_mozi_acl_role_add_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部