Returns all Role resources.
GET {{baseUrl}}/Roles?filter=<string>&sortBy=<string>&sortOrder=<string>&startIndex=<integer>&count=<integer>&attributes=<string>&excludedAttributes=<string>
This endpoint returns all Role resources. Attributes to include in the response can be specified with the 'attributes' query parameter. Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter. The core schema is urn:ietf:params:scim:schemas:sailpoint:1.0:Role.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter | string | Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.<br/><br/>Example: filter=name eq "Data Analyst" | |
sortBy | string | Allows sorting the results by a resource's attributes.<br/><br/>Example: sortBy="name" | |
sortOrder | string | Determines what order to sort results in.<br/><br/>Example: sortOrder="descending" | |
startIndex | string | Determines the starting index of the result set.<br/><br/>Example: startIndex=1100 | |
count | string | Specifies the number of results per page.<br/><br/>Example: count=10 | |
attributes | string | The Role attributes to include in the response. The query parameter value is a comma-separated list of fields to be returned in the response for each Role.<br/><br/>Example: attributes=name,type,classifications<br/><br/> The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for a Role. | |
excludedAttributes | string | The Role attributes to exclude frome the response. The query parameter value is a comma-separated list of fields to be excluded from the response for each Role.<br/><br/>Example: excludedAttributes=permits,requirements,inheritance<br/><br/> The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for a Role. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"totalResults":-13732783,"startIndex":1,"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"Resources":[{"id":"c0b4568a4fe7458c434ee77d1fbt156b","name":"ADDirect-Production Manager","descriptions":[{"locale":"en_US","value":"Directs production operations and processes for a plant, division, or company. Plans and maintains production schedules. Manages facilities and equipment maintenance."}],"type":{"iiq":false,"requirements":false,"permits":false,"displayName":"IT","manualAssignment":false,"name":"it","autoAssignment":false,"assignmentSelector":false},"displayableName":"Staging Test Engineer - IT","active":true,"activationDate":"2022-02-11T01:08:45.866-05:00","deactivationDate":"2022-02-11T01:08:45.866-05:00","owner":{"displayName":"commodo et dolore","value":"et","$ref":"in incididunt reprehenderi"},"inheritance":{"displayName":"commodo occae","value":"nisi ","$ref":"ut"},"requirements":{"displayName":"consequat sit Lorem commodo","value":"laboris Excepteur Lorem cupidatat aliqua","$ref":"velit"},"permits":{"displayName":"sit","value":"ipsum","$ref":"fugiat commodo ipsum culpa co"},"classifications":{"source":"Excepteur fugiat sit voluptate","effective":false,"classification":{"name":"in anim laborum","displayName":"reprehende","origin":"non minim occaecat sunt","type":"e"}},"meta":{"created":"2022-02-11T01:34:04.074-05:00","location":"http://localhost:8080/iiq/scim/v2/Roles/c0b4568a4fe7458c434ee77d1fbt156b","lastModified":"2022-02-11T01:08:45.866-05:00","version":"W/\\\"1644561244074\\\"","resourceType":"Role"},"schemas":["urn:ietf:params:scim:schemas:sailpoint:1.0:Role"]},{"id":"c0b4568a4fe7458c434ee77d1fbt156b","name":"ADDirect-Production Manager","descriptions":[{"locale":"en_US","value":"Directs production operations and processes for a plant, division, or company. Plans and maintains production schedules. Manages facilities and equipment maintenance."}],"type":{"iiq":false,"requirements":false,"permits":false,"displayName":"IT","manualAssignment":false,"name":"it","autoAssignment":false,"assignmentSelector":false},"displayableName":"Staging Test Engineer - IT","active":true,"activationDate":"2022-02-11T01:08:45.866-05:00","deactivationDate":"2022-02-11T01:08:45.866-05:00","owner":{"displayName":"exercitation","value":"consequat ex","$ref":"eu commodo"},"inheritance":{"displayName":"consectetur","value":"anim dolore pariatur fugiat","$ref":"null"},"requirements":{"displayName":"esse ","value":"et consequat eu enim","$ref":"deserunt Lorem cillum culpa ut"},"permits":{"displayName":"enim velit occaecat labore et","value":"sed veniam","$ref":"cupidatat magna aliquip adipisicing tempor"},"classifications":{"source":"dolore non conse","effective":false,"classification":{"name":"mollit occaecat irure","displayName":"ea Lorem nostrud ut aute","origin":"aliqua","type":"ut"}},"meta":{"created":"2022-02-11T01:34:04.074-05:00","location":"http://localhost:8080/iiq/scim/v2/Roles/c0b4568a4fe7458c434ee77d1fbt156b","lastModified":"2022-02-11T01:08:45.866-05:00","version":"W/\\\"1644561244074\\\"","resourceType":"Role"},"schemas":["urn:ietf:params:scim:schemas:sailpoint:1.0:Role"]}]}