Crear rol

Utilice la API Crear nuevo rol para crear uno nuevo rol con permisos en Control Room.

Solicitud

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

Header: X-Authorization <<authentication token>>

Todas las llamadas a la API deben contener un token de autenticación en el encabezado de la solicitud.Utilice la API Autenticación para generar un Web Token JSON.Consulte API de autenticación.

Cuerpo de la solicitud:

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

Parámetros de solicitud


Parámetro	Tipo	Obligatorio	Descripción
nombre	Cadena	Sí	Ponga el nombre al rol.
descripción	Cadena	No	Descripción del rol.
permisos	Matriz	No	Matriz de permisos que se concederán para el rol. Cada permiso requiere los parámetros obligatorios. Para obtener más detalles sobre los parámetros, consulte más abajo.
principales	Matriz	No	Matriz/colección de principales (usuarios) a los que se concederá acceso con el rol. Para obtener más Información sobre los parámetros, consulte 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 manera única el permiso.
acción	Cadena	No	La acción que habilita el permiso.
resourceId	Cadena	No	Id de recursos al que pertenece la acción.
resourceType	Matriz	No	El grupo de recursos al que pertenece la acción. Generalmente, a un usuario se otorga el permiso de rol junto con el permiso de administración de usuarios. Roles y permisos

parámetros de la matriz principal


Parámetro	Tipo	Obligatorio	Descripción
id	Entero	No	ID del usuario.
nombre de usuario	Cadena	No	Nombre de usuario del usuario.
subjectId	Cadena	No	ID de asunto del usuario.
dominio	Cadena	No	Dominio de Active Directory, si el usuario es un usuario de AD.
autoLoginEnabled	Booleano	No	Marca para indicar si el inicio de sesión automático está o no habilitado.
eliminado	Booleano	No	Marca para indicar si el usuario está o no eliminado.
emailVerified	Booleano	No	Marca para indicar si el correo electrónico está o no verificado.
pwdExpired	Booleano	No	Marca para indicar si la contraseña caducó o no.

Respuesta

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

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 Control Room APIs en la Community Edition, pero la funcionalidad de la API está limitada. Necesita una Edition de Automatización 360 con licencia para acceder a la funcionalidad completa de las API.

La API REST responde a cada solicitud con un código de respuesta HTTP.Para ver los códigos de respuesta, consulte Códigos de respuesta de API.