API de búsqueda de roles
Utilice la API Buscar roles para recuperar una lista de todos los roles en Control Room.
Antes de empezar
Asegúrese de tener un rol de administrador o un rol personalizado con permiso para Ver roles para buscar roles.
Procedimiento
- Agregue el token de autenticación al encabezado de la solicitud.
- Aplicar filtros para realizar consultas condicionales básicas y control de paginación para procesar páginas web. Existen tres características básicas relacionadas con el filtrado: condiciones de filtrado, orden de columnas y parámetros de paginación. Consulte Filtros en un cuerpo de solicitud de API.
-
Utilice el método POST y la URL de punto final:
<your control room>/v1/gestión de usuarios/funciones/lista
La siguiente solicitud encuentra roles con unnombre
que contiene unaprueba
y se crearon entre el 1 de junio y el 6 de octubre de 2020.Cuerpo de la solicitud:{ "fields": [], "filter": { "operator": "and", "operands": [ { "operator": "substring", "field": "name", "value": "test" }, { "operator": "gt", "field": "createdOn", "value": "2020-06-01T00:00:00.989Z" }, { "operator": "lt", "field": "createdOn", "value": "2020-10-06T23:00:00.123Z" } ] } }
-
Enviar la
En este ejemplo, el cuerpo de respuesta trae cinco roles con la
prueba
de nombre, y cuándo y quién creó un rol, así como también, si un rol fue un rol creado por el sistema o no.cuerpo de respuesta;{ "page": { "offset": 0, "total": 106, "totalFilter": 5 }, "list": [ { "id": 102, "name": "whatfixtest", "description": "", "countPrincipals": 0, "version": 3, "createdBy": 278, "createdOn": "2020-06-02T18:22:55.633Z", "updatedBy": 34, "updatedOn": "2020-09-02T23:26:11.930Z", "systemRole": false }, { "id": 115, "name": "export-role-test", "description": "", "countPrincipals": 5, "version": 8, "createdBy": 261, "createdOn": "2020-06-04T10:59:45.343Z", "updatedBy": 96, "updatedOn": "2020-09-14T16:56:33.310Z", "systemRole": false }, { "id": 391, "name": "testROle", "description": "", "countPrincipals": 0, "version": 0, "createdBy": 169, "createdOn": "2020-07-01T01:08:45.243Z", "updatedBy": 169, "updatedOn": "2020-07-01T01:08:45.243Z", "systemRole": false }, { "id": 401, "name": "bi-test-role", "description": "", "countPrincipals": 1, "version": 5, "createdBy": 1, "createdOn": "2020-07-02T02:56:57.893Z", "updatedBy": 96, "updatedOn": "2020-09-14T16:56:33.280Z", "systemRole": false }, { "id": 470, "name": "repo_test", "description": "", "countPrincipals": 1, "version": 1, "createdBy": 1, "createdOn": "2020-09-09T07:49:46.993Z", "updatedBy": 96, "updatedOn": "2020-09-14T16:56:32.913Z", "systemRole": false } ] }
La API REST responde a cada solicitud con un código de respuesta HTTP. Para obtener detalles sobre los códigos de respuesta, consulte Códigos de respuesta de API.