API Rechercher des rôles
Utilisez l’API Rechercher des rôles pour récupérer une liste de tous les rôles dans la Control Room.
Prérequis
Assurez-vous d’avoir un rôle d’administrateur ou un rôle personnalisé avec l’autorisation Afficher les rôles pour rechercher des rôles.
Procédure
- Ajoutez le jeton d’authentification à l’en-tête de la requête.
- Appliquez des filtres pour exécuter des requêtes conditionnelles de base et une commande de pagination pour le traitement des pages Web. Il existe trois fonctions de base liées au filtrage : conditions de filtrage, colonnes de tri et paramètres de pagination. Reportez-vous à la rubrique Filtres dans un corps de demande API.
-
Utilisez la méthode POST et l’URL du point de terminaison :
<your control room>/v1/usermanagement/roles/list
La requête suivante trouve des rôles ayant unnom
contenanttest
et créés entre le 1er juin et le 6 octobre 2020.Corps de la requête :{ "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" } ] } }
-
Envoyez la requête.
Dans cet exemple, le corps de réponse apporte cinq rôles avec le nom
test
et quand et qui a créé un rôle, et indique si le rôle a été créé par le système ou non.Corps de réponse :{ "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 } ] }
L’API REST répond à chaque requête par un code de réponse HTTP. Pour plus d’informations sur les codes de réponse, consultez Codes de réponse de l'API.