역할 생성
역할 생성 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
}
]
}요청 매개변수
| 매개변수 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
| 이름 | 문자열 | 예 | 역할의 이름입니다. |
| 설명 | 문자열 | 아니요 | 역할에 대한 설명입니다. |
| 권한 | Array | 아니요 | 역할에 부여될 권한의 배열입니다. 각 권한에는 필수 매개변수가 필요합니다. 매개변수에 대한 자세한 내용은 다음을 참조하십시오. |
| principals | Array | 아니요 | 역할을 사용하여 액세스 권한을 부여할 보안 주체(사용자)의 배열/모음입니다. 매개변수에 대한 자세한 내용은 다음을 참조하십시오. |
| 매개변수 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
| id | 정수 | 아니요 | 권한을 고유하게 식별하는 숫자 값. |
| 작업 | 문자열 | 아니요 | 권한에 의해 활성화하는 작업. |
| resourceId | 문자열 | 아니요 | 작업이 속한 리소스 ID입니다. |
| resourceType | Array | 아니요 | 작업이 속한 리소스 그룹. 일반적으로 사용자에게는 사용자 관리 권한과 함께 역할 권한이 부여됩니다. 역할 및 권한 |
| 매개변수 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
| id | 정수 | 아니요 | 사용자의 ID입니다. |
| 사용자 이름 | 문자열 | 아니요 | 사용자의 사용자 이름입니다. |
| subjectId | 문자열 | 아니요 | 사용자의 주체 ID입니다. |
| domain | 문자열 | 아니요 | 사용자가 AD 사용자인 경우 Active Directory 도메인입니다. |
| autoLoginEnabled | 부울 | 아니요 | 자동 로그인이 활성화되었는지 여부를 나타내는 플래그입니다. |
| 삭제됨 | 부울 | 아니요 | 사용자가 삭제되었는지 여부를 나타내는 플래그입니다. |
| emailVerified | 부울 | 아니요 | 이메일이 확인되었는지 여부를 나타내는 플래그입니다. |
| pwdExpired | 부울 | 아니요 | 비밀번호가 만료되었는지 여부를 나타내는 플래그입니다. |
응답
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 | 문자열 | 역할의 생성 타임스탬프입니다. |
| updatedBy | 정수 | 역할에 대한 최신 업데이트를 수행한 사용자의 ID입니다. |
| updatedOn | 문자열 | 역할의 최신 업데이트 타임스탬프입니다. |
| 권한 | Array | 역할에 할당된 고유한 권한의 배열입니다. |
| principals | Array | 역할에 할당된 고유한 사용자의 배열입니다. |
주: Community Edition에서 Control Room APIs을 볼 수 있지만, API 기능은 제한됩니다. API의 전체 기능에 액세스하려면 라이선스가 인가된 Automation 360 에디션이 필요합니다.
REST API는 HTTP 응답 코드를 이용하여 각 요청에 응답합니다. 응답 코드는 API 응답 코드를 참고하십시오.