Retrieves all potential role summaries

GET {{baseUrl}}/role-mining-potential-roles

Returns all potential role summaries that match the query parameters

Request Params

KeyDatatypeRequiredDescription
sortersstringSort results using the standard syntax described in V3 API Standard Collection Parameters

Sorting is supported for the following fields: createdDate, identityCount, entitlementCount, freshness, quality | | filters | string | | Filter results using the standard syntax described in V3 API Standard Collection Parameters

Filtering is supported for the following fields and operators:

createdById: eq, sw, co

createdByName: eq, sw, co

description: sw, co

endDate: le, lt

freshness: eq, ge, gt, le, lt

name: eq, sw, co, ge, gt, le, lt

quality: eq, ge, gt, le, lt

startDate: ge, gt

saved: eq

type: eq, ge, gt, le, lt

scopingMethod: eq

sessionState: eq

identityAttribute: co | | offset | number | | Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information. | | limit | number | | Max number of results to return. See V3 API Standard Collection Parameters for more information. | | count | boolean | | If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

See V3 API Standard Collection Parameters for more information. |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

[{"id":"e0cc5d7d-bf7f-4f81-b2af-8885b09d9923","name":"Potential Role - e0cc5d","potentialRoleRef":{"id":"e0cc5d7d-bf7f-4f81-b2af-8885b09d9923","name":"Potential Role - e0cc5d"},"identityCount":25,"entitlementCount":15,"identityGroupStatus":"OBTAINED","provisionState":"PENDING","roleId":"2a4be6fbcf3c4e66b95a0c15ffd591","density":90,"freshness":70,"quality":80,"type":"SPECIALIZED","session":{"id":"9f36f5e5-1e81-4eca-b087-548959d91c71","name":"Saved RM Session - 07/10","minNumIdentitiesInPotentialRole":20,"pruneThreshold":5,"saved":true,"scope":{"identityIds":["2c918090761a5aac0176215c46a62d58","2c918090761a5aac01722015c46a62d42"],"criteria":"source.name:DataScienceDataset"},"type":"SPECIALIZED","state":"CREATED","scopingMethod":"MANUAL"}},{"id":"e0cc5d7d-bf7f-4f81-b2af-8885b09d9923","name":"Potential Role - e0cc5d","potentialRoleRef":{"id":"e0cc5d7d-bf7f-4f81-b2af-8885b09d9923","name":"Potential Role - e0cc5d"},"identityCount":25,"entitlementCount":15,"identityGroupStatus":"OBTAINED","provisionState":"PENDING","roleId":"2a4be6fbcf3c4e66b95a0c15ffd591","density":90,"freshness":70,"quality":80,"type":"SPECIALIZED","session":{"id":"9f36f5e5-1e81-4eca-b087-548959d91c71","name":"Saved RM Session - 07/10","minNumIdentitiesInPotentialRole":20,"pruneThreshold":5,"saved":true,"scope":{"identityIds":["2c918090761a5aac0176215c46a62d58","2c918090761a5aac01722015c46a62d42"],"criteria":"source.name:DataScienceDataset"},"type":"SPECIALIZED","state":"CREATED","scopingMethod":"MANUAL"}}]