Solicitud

PUT https://{{ControlRoomURL}}/v1/usermanagement/roles/<role ID>

Header: X-Authorization <<authentication token>>

Todas las llamadas a la API deben contener un token de autenticación en la cabecera de la solicitud. Utilizar la Autenticación para generar un token web JSON. Véase API de autenticación.

Cuerpo de la solicitud:

{
   "id":25,
   "name":"Trigger Manager",
   "principals":[
      {
         "id":3
      },
      {
         "id":4
      }
   ],
   "description":"View and Manage the triggers",
   "permissions":[
      {
         "id":148,
         "action":"view",
         "resourceType":"dashboard",
         "resourceId":null
      },
      {
         "id":58,
         "action":"myschedule",
         "resourceType":"taskscheduling",
         "resourceId":null
      },
      {
         "id":149,
         "action":"view",
         "resourceType":"eventtriggers",
         "resourceId":null
      },
      {
         "id":150,
         "action":"manage",
         "resourceType":"eventtriggers",
         "resourceId":null
      },
      {
         "id":131,
         "action":"managemytriggers",
         "resourceType":"eventtriggers",
         "resourceId":null
      },
      {
         "id":59,
         "action":"managecredentials",
         "resourceType":"credentials",
         "resourceId":null
      },
      {
         "id":30,
         "action":"view",
         "resourceType":"devices",
         "resourceId":null
      }
   ],
   "existingRepositoryPermissions":[
      
   ],
   "version":0
}

Parámetros de solicitud


Parámetro	Tipo	Obligatorio	Descripción
nombre	Cadena	Sí	Introduzca el nombre del rol.
descripción	Cadena	No	Descripción de la función.
permisos	Matriz	No	Un conjunto de permisos que se concederán para el rol. Cada permiso requiere los parámetros obligatorios. Para más detalles sobre los parámetros, véase más abajo.
principales	Matriz	No	Una matriz/colección de directores (usuarios) a los que se les concederá acceso con el rol. Para más información sobre los parámetros, véase más abajo.

parámetros de la matriz de permisos


Parámetro	Tipo	Obligatorio	Descripción
id	Entero	No	El valor numérico que identifica de forma exclusiva el permiso.
acción	Cadena	No	La acción que permite el permiso.
resourceId	Cadena	No	El ID del recurso al que pertenece la acción.
resourceType	Matriz	No	El grupo de recursos al que pertenece la acción. Normalmente, un usuario recibe el permiso de rol junto con el permiso de gestión de usuarios. Roles and permissions

parámetros de la matriz prinicpals


Parámetro	Tipo	Obligatorio	Descripción
id	Entero	No	Id del usuario.
nombre de usuario	Cadena	No	Nombre del usuario.
subjectId	Cadena	No	Id. de asunto del usuario.
dominio	Cadena	No	Dominio del directorio activo, si el usuario es un usuario AD.
autoLoginEnabled	Booleano	No	Bandera para indicar si el inicio de sesión automático está activado o no.
borrado	Booleano	No	Bandera para indicar si el usuario es eliminado o no.
emailVerificado	Booleano	No	Bandera para indicar si el correo electrónico está verificado o no.
pwdExpired	Booleano	No	Bandera para indicar si la contraseña ha caducado o no.

Respuesta

200 OK

{
   "id":25,
   "createdBy":1,
   "createdOn":"2022-04-11T11:53:03Z",
   "updatedBy":1,
   "updatedOn":"2022-04-11T12:01:31Z",
   "tenantId":1,
   "version":1,
   "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_user",
         "description":"",
         "deleted":false,
         "disabled":false,
         "email":"john.doe@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":4,
         "createdBy":1,
         "createdOn":"2022-04-04T15:32:38Z",
         "updatedBy":1,
         "updatedOn":"2022-04-04T15:32:38Z",
         "tenantId":1,
         "version":11,
         "tenantUuid":"282978c4-6386-c13a-92ac-5009e3cfd6b3",
         "username":"test_admin",
         "description":"",
         "deleted":false,
         "disabled":false,
         "email":"testadmin@aa.com",
         "firstName":"Test",
         "lastName":"Admin",
         "autoLoginEnabled":false,
         "emailVerified":true,
         "clientRegistered":false,
         "passwordSet":true,
         "questionsSet":true,
         "activeDirectory":false,
         "passwordChangedOn":"2022-04-04T15:33:22Z",
         "deviceCredentialAttested":false,
         "multipleLoginAllowed":true
      }
   ]
}

Parámetros de respuesta


Parámetro	Tipo	Descripción
id	Entero	Identificador único que representa el nuevo rol creado.
nombre	Cadena	Nombre del rol creado.
descripción	Cadena	Descripción del rol creado.
versión	Entero	Versión de la instancia del rol.
creado por	Entero	ID del usuario que creó el rol.
creado el	Cadena	La marca de tiempo de creación del rol.
actualizado por	Entero	ID del usuario que ha realizado la última actualización del rol.
actualizado el	Cadena	La última marca de tiempo de actualización del rol.
permisos	Matriz	Una matriz de permisos únicos que se han asignado al rol.
principales	Matriz	Una matriz de usuarios únicos que se han asignado al rol.

Nota: Puede ver el Control Room APIs en el Community Editionpero la funcionalidad de la API es limitada. Necesita una licencia Automation 360 Edition para acceder a toda la funcionalidad de las APIs.

La API REST responde a cada solicitud con un código de respuesta HTTP. Para los códigos de respuesta, véase API response codes.

Actualizar el papel

Solicitud

Parámetros de solicitud

Respuesta

Parámetros de respuesta