创建角色
使用 Create role API 创建一个具有权限的新角色 Control Room.
请求
POST https://{{ControlRoomURL}}//v1/usermanagement/rolesHeader: X-Authorization <<authentication token>>{
"name":"Trigger Manager",
"description":"View and Manage the triggers",
"permissions":[
{
"id":148,
"action":"view",
"resourceType":"dashboard",
"resourceId":null
},
{
"id":58,
"action":"myschedule",
"resourceType":"taskscheduling",
"resourceId":null
},
{
"id":59,
"action":"managecredentials",
"resourceType":"credentials",
"resourceId":null
},
{
"id":30,
"action":"view",
"resourceType":"devices",
"resourceId":null
},
{
"id":150,
"action":"manage",
"resourceType":"eventtriggers",
"resourceId":null
},
{
"id":149,
"action":"view",
"resourceType":"eventtriggers",
"resourceId":null
},
{
"id":131,
"action":"managemytriggers",
"resourceType":"eventtriggers",
"resourceId":null
}
],
"principals":[
{
"id":3
}
]
}请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| 姓名 | 字符串 | 是 | 角色的名称。 |
| description | 字符串 | 否 | 角色描述。 |
| permissions | 数组 | 否 | 将为角色授予的权限数组。每个权限都需要强制参数。有关参数的更多详细信息，请参见下文。 |
| principals | 数组 | 否 | 将被授予角色访问权限的主体（用户）的数组/集合。有关参数的更多信息，请参见下文。 |
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| id | 整数 | 否 | 唯一标识权限的数值。 |
| 行动 | 字符串 | 否 | 权限启用的操作。 |
| 资源 ID | 字符串 | 否 | 动作所属的资源id。 |
| 资源类型 | 数组 | 否 | 操作所属的资源组。 通常，用户被授予角色权限以及用户管理权限。 角色和权限 |
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| id | 整数 | 否 | 用户的 ID。 |
| 用户名 | 字符串 | 否 | 用户的用户名。 |
| 主题标识 | 字符串 | 否 | 用户的主题 ID。 |
| 领域 | 字符串 | 否 | Active Directory 域，如果用户是 AD 用户。 |
| 自动登录启用 | 布尔值 | 否 | 指示是否启用自动登录的标志。 |
| 已删除 | 布尔值 | 否 | 指示用户是否被删除的标志。 |
| 电子邮件已验证 | 布尔值 | 否 | 标记以指示电子邮件是否经过验证。 |
| 密码过期 | 布尔值 | 否 | 指示密码是否过期的标志。 |
响应
201 Created{
"id":25,
"createdBy":1,
"createdOn":"2022-04-11T11:53:03Z",
"updatedBy":1,
"updatedOn":"2022-04-11T11:53:03Z",
"tenantId":1,
"version":0,
"tenantUuid":"282978c4-6386-c13a-92ac-5009e3cfd6b3",
"description":"View and Manage the triggers",
"name":"Trigger Manager",
"permissions":[
{
"id":59,
"createdBy":0,
"createdOn":"2022-02-28T23:49:21Z",
"updatedBy":0,
"updatedOn":"2022-02-28T23:49:21Z",
"tenantId":1,
"version":0,
"tenantUuid":"282978c4-6386-c13a-92ac-5009e3cfd6b3",
"action":"managecredentials",
"resourceId":null,
"resourceType":"credentials"
},
{
"id":131,
"createdBy":0,
"createdOn":"2022-02-28T23:49:31Z",
"updatedBy":0,
"updatedOn":"2022-02-28T23:49:31Z",
"tenantId":1,
"version":0,
"tenantUuid":"282978c4-6386-c13a-92ac-5009e3cfd6b3",
"action":"managemytriggers",
"resourceId":null,
"resourceType":"eventtriggers"
},
{
"id":149,
"createdBy":0,
"createdOn":"2022-02-28T23:49:42Z",
"updatedBy":0,
"updatedOn":"2022-02-28T23:49:42Z",
"tenantId":1,
"version":0,
"tenantUuid":"282978c4-6386-c13a-92ac-5009e3cfd6b3",
"action":"view",
"resourceId":null,
"resourceType":"eventtriggers"
},
{
"id":58,
"createdBy":0,
"createdOn":"2022-02-28T23:49:21Z",
"updatedBy":0,
"updatedOn":"2022-02-28T23:49:21Z",
"tenantId":1,
"version":0,
"tenantUuid":"282978c4-6386-c13a-92ac-5009e3cfd6b3",
"action":"myschedule",
"resourceId":null,
"resourceType":"taskscheduling"
},
{
"id":148,
"createdBy":0,
"createdOn":"2022-02-28T23:49:38Z",
"updatedBy":0,
"updatedOn":"2022-02-28T23:49:38Z",
"tenantId":1,
"version":0,
"tenantUuid":"282978c4-6386-c13a-92ac-5009e3cfd6b3",
"action":"view",
"resourceId":null,
"resourceType":"dashboard"
},
{
"id":150,
"createdBy":0,
"createdOn":"2022-02-28T23:49:42Z",
"updatedBy":0,
"updatedOn":"2022-02-28T23:49:42Z",
"tenantId":1,
"version":0,
"tenantUuid":"282978c4-6386-c13a-92ac-5009e3cfd6b3",
"action":"manage",
"resourceId":null,
"resourceType":"eventtriggers"
},
{
"id":30,
"createdBy":0,
"createdOn":"2022-02-28T23:49:21Z",
"updatedBy":0,
"updatedOn":"2022-02-28T23:49:21Z",
"tenantId":1,
"version":0,
"tenantUuid":"282978c4-6386-c13a-92ac-5009e3cfd6b3",
"action":"view",
"resourceId":null,
"resourceType":"devices"
}
],
"countPrincipals":0,
"systemRole":false,
"principals":[
{
"id":3,
"createdBy":1,
"createdOn":"2022-03-17T19:33:06Z",
"updatedBy":1,
"updatedOn":"2022-04-08T21:54:29Z",
"tenantId":1,
"version":274,
"tenantUuid":"282978c4-6386-c13a-92ac-5009e3cfd6b3",
"username":"john_doe",
"description":"",
"deleted":false,
"disabled":false,
"email":"aa@aa.com",
"firstName":"John",
"lastName":"Doe",
"autoLoginEnabled":true,
"emailVerified":true,
"clientRegistered":false,
"passwordSet":true,
"questionsSet":true,
"activeDirectory":false,
"passwordChangedOn":"2022-03-17T19:33:59Z",
"deviceCredentialAttested":false,
"multipleLoginAllowed":true
}
]
}响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| id | 整数 | 表示创建的新角色的唯一标识符。 |
| name | 字符串 | 创建的角色的名称。 |
| description | 字符串 | 创建的角色的描述。 |
| version | 整数 | 角色实例的版本。 |
| createdBy | 整数 | 创建对象的用户的 ID。 |
| createdOn | 字符串 | 角色的创建时间戳。 |
| updatedBy | 整数 | 对角色进行了最新更新的用户的 ID。 |
| updatedOn | 字符串 | 角色的最新更新时间戳。 |
| permissions | 数组 | 已分配给角色的一组唯一权限。 |
| principals | 数组 | 已分配给角色的一组唯一用户。 |
注： 您可以查看 Control Room APIs 在里面 Community Edition，但 API 功能有限。你需要有执照的 Automation 360 用于访问 API 全部功能的版本。
REST API 使用 HTTP 响应代码响应每个请求。 有关响应代码，请参阅 API 响应代码.