Returns a Role resource based on ID or name.
GET {{baseUrl}}/Roles/:roleId?lookupByName=<boolean>&attributes=<string>&excludedAttributes=<string>
The Role resource with matching ID or name is returned. 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 |
|---|---|---|---|
lookupByName | string | A boolean value that determines if the Role resource will be looked up by name instead of Id (value in path parameter 'roleId'). Setting this query parameter to true will cause the value pulled from the 'roleId' path parameter to be treated as a name when searching for the resource.<br/><br/>Example: scim/v2/Roles/Data Analyst?lookupByName=true | |
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<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<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
{"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":"id","value":"ut ipsum irure est","$ref":"ipsum Duis esse"},"inheritance":{"displayName":"et consectetur","value":"laborum Lorem culpa in","$ref":"fugiat"},"requirements":{"displayName":"tempor magna officia","value":"magna sunt","$ref":"ipsum in velit"},"permits":{"displayName":"sed nisi ut Excepteur commodo","value":"est ut","$ref":"ullamco et"},"classifications":{"source":"elit irure","effective":false,"classification":{"name":"reprehe","displayName":"ullam","origin":"in eiusmod nulla ea","type":"proident"}},"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"]}