建立角色

使用 Create role API 創建一個具有權限的新角色 Control Room.

要求

POST https://{{ControlRoomURL}}//v1/usermanagement/roles

Header: X-Authorization <<authentication token>>

所有 API 調用都必須包含來自驗證 API （生成 JSON Web 令牌）或來自 OAuth 服務的不記名令牌。您不能在 API 中同時使用兩者。

要求本文：

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

要求參數


參數	類型	必填	說明
名稱	字串	是	角色的名稱。
說明	字串	否	角色描述。
權限	陣列	否	將為角色授予的權限數組。每個權限都需要強制參數。有關參數的更多詳細信息，請參見下文。
主體	陣列	否	將被授予角色訪問權限的主體（用戶）的數組/集合。有關參數的更多信息，請參見下文。

權限數組參數


參數	類型	必填	說明
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	整數	代表已建立新角色的唯一識別碼。
名稱	字串	已建立角色的名稱。
說明	字串	已建立角色的說明。
版本	整數	角色實例的版本。
createdBy	整數	建立角色的使用者 ID。
createdOn	字串	建立角色的時間戳記。
更新者	整數	最近一次更新角色的使用者 ID。
更新日期	字串	最近一次更新角色的時間戳記。
權限	陣列	已指派給角色的一系列唯一權限。
主體	陣列	已指派給角色的一系列唯一使用者。

註: 您可以查看 Control Room APIs 在裡面 Community Edition，但 API 功能有限。你需要一個許可 Automation 360 版本以訪問 API 的全部功能。

REST API 使用 HTTP 響應代碼響應每個請求。有關響應代碼，請參閱 API響應代碼.