---
id: get-roles
sidebar_label: Returns all Role resources.
hide_title: true
hide_table_of_contents: true
api: {"operationId":"getRoles","tags":["Roles"],"description":"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.","parameters":[{"in":"query","name":"filter","schema":{"type":"string"},"description":"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\""},{"in":"query","name":"sortBy","schema":{"type":"string"},"description":"Allows sorting the results by a resource's attributes.<br/><br/>**Example**: sortBy=\"name\""},{"in":"query","name":"sortOrder","schema":{"type":"string"},"description":"Determines what order to sort results in.<br/><br/>**Example**: sortOrder=\"descending\""},{"in":"query","name":"startIndex","schema":{"type":"integer"},"description":"Determines the starting index of the result set.<br/><br/>**Example**: startIndex=1100"},{"in":"query","name":"count","schema":{"type":"integer"},"description":"Specifies the number of results per page.<br/><br/>**Example**: count=10"},{"in":"query","name":"attributes","schema":{"type":"string"},"description":"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."},{"in":"query","name":"excludedAttributes","schema":{"type":"string"},"description":"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."}],"responses":{"200":{"description":"Returns all SCIM Role resources.","content":{"application/json":{"schema":{"properties":{"totalResults":{"description":"Number of Role resources returned","type":"integer","example":"18,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"type":"array","items":{"properties":{"id":{"description":"IIQ ID of the Role.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"name":{"description":"Unique name for the Role. This name MUST be unique across the entire set of Roles.","type":"string","example":"ADDirect-Production Manager"},"descriptions":{"description":"A list of localized descriptions of the Role.","type":"array","example":[{"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":{"description":"The type of the Role.","type":"object","example":{"iiq":false,"requirements":false,"permits":false,"displayName":"IT","manualAssignment":false,"name":"it","autoAssignment":false,"assignmentSelector":false}},"displayableName":{"description":"Displayable name of the Role.","type":"string","example":"Staging Test Engineer - IT"},"active":{"description":"Flag to indicate this Role is enabled or active.","type":"boolean","example":true},"activationDate":{"description":"The date the Role will turn from inactive/disabled to active/enabled.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"deactivationDate":{"description":"The date the Role will turn from active/enabled to inactive/disabled.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"owner":{"description":"The owner of the Role.","type":"object","properties":{"displayName":{"description":"Display name of the Role owner.","type":"string","example":"Lori Ferguson"},"value":{"description":"ID of the Role owner.","type":"string","example":"ac1301737f901991817f90d9eb050372"},"$ref":{"description":"URI reference of the Role owner resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Users/ac1301737f901991817f90d9eb050372"}}},"inheritance":{"description":"Parent Roles this role inherits from.","type":"array","properties":{"displayName":{"description":"Display name of the parent Role.","type":"string","example":"Finance & Accounting"},"value":{"description":"ID of the parent Role.","type":"string","example":"ac1301737f901991817f90d9f054041c"},"$ref":{"description":"URI reference of the parent Role resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9f054041c"}}},"requirements":{"description":"Roles this role requires. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are required to support a business role.","type":"array","properties":{"displayName":{"description":"Display name of the required Role.","type":"string","example":"Accounting General Access - IT"},"value":{"description":"ID of the required Role.","type":"string","example":"ac1301737f901991817f90d9ed110387"},"$ref":{"description":"URI reference of the required Role resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9ed110387"}}},"permits":{"description":"Roles this role permits. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are allowed to support a business role.","type":"array","properties":{"displayName":{"description":"Display name of the permitted Role.","type":"string","example":"Accounts Payable Access - IT"},"value":{"description":"ID of the permitted Role.","type":"string","example":"ac1301737f901991817f90d9ed170388"},"$ref":{"description":"URI reference of the permitted Role resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9ed170388"}}},"classifications":{"description":"Classifications of this Role.","type":"array","example":[{"effective":false,"source":"UI","classification":{"displayName":"Special2","origin":"JDBCDirectDemoData","name":"Special2"}},{"effective":false,"source":"UI","classification":{"displayName":"Special7","origin":"JDBCDirectDemoData","name":"Special7"}}],"properties":{"source":{"description":"The source of the ObjectClassification.","type":"string"},"effective":{"description":"Flag indicating this is an effective Classification.","type":"boolean"},"classification":{"description":"Classification of this Object.","type":"object","properties":{"name":{"description":"The name of the Classification.","type":"string"},"displayName":{"description":"The displayName of the Classification.","type":"string"},"origin":{"description":"The origin of the Classification.","type":"string"},"type":{"description":"The type of the Classification. This can be used to group Classifications in/across different origins.","type":"string"}}}}},"meta":{"description":"Metadata of the SCIM resource.","properties":{"created":{"description":"Datetime this Role was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the SCIM resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Roles/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the Role was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the SCIM resource.","type":"string","example":"W/\\\"1644561244074\\\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"Role"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:Role"]}}}}}}},"application/scim+json":{"schema":{"properties":{"totalResults":{"description":"Number of Role resources returned.","type":"integer","example":"1500,"},"startIndex":{"description":"The starting index of the resource set list. Can be specified with startIndex query parameter.","type":"integer","example":1},"schemas":{"description":"SCIM Schema used for response.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"Resources":{"description":"The SCIM resources returned for this endpoint.","type":"array","items":{"properties":{"id":{"description":"IIQ ID of the Role.","type":"string","example":"c0b4568a4fe7458c434ee77d1fbt156b"},"name":{"description":"Unique name for the Role. This name MUST be unique across the entire set of Roles.","type":"string","example":"ADDirect-Production Manager"},"descriptions":{"description":"A list of localized descriptions of the Role.","type":"array","example":[{"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":{"description":"The type of the Role.","type":"object","example":{"iiq":false,"requirements":false,"permits":false,"displayName":"IT","manualAssignment":false,"name":"it","autoAssignment":false,"assignmentSelector":false}},"displayableName":{"description":"Displayable name of the Role.","type":"string","example":"Staging Test Engineer - IT"},"active":{"description":"Flag to indicate this Role is enabled or active.","type":"boolean","example":true},"activationDate":{"description":"The date the Role will turn from inactive/disabled to active/enabled.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"deactivationDate":{"description":"The date the Role will turn from active/enabled to inactive/disabled.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"owner":{"description":"The owner of the Role.","type":"object","properties":{"displayName":{"description":"Display name of the Role owner.","type":"string","example":"Lori Ferguson"},"value":{"description":"ID of the Role owner.","type":"string","example":"ac1301737f901991817f90d9eb050372"},"$ref":{"description":"URI reference of the Role owner resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Users/ac1301737f901991817f90d9eb050372"}}},"inheritance":{"description":"Parent Roles this role inherits from.","type":"array","properties":{"displayName":{"description":"Display name of the parent Role.","type":"string","example":"Finance & Accounting"},"value":{"description":"ID of the parent Role.","type":"string","example":"ac1301737f901991817f90d9f054041c"},"$ref":{"description":"URI reference of the parent Role resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9f054041c"}}},"requirements":{"description":"Roles this role requires. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are required to support a business role.","type":"array","properties":{"displayName":{"description":"Display name of the required Role.","type":"string","example":"Accounting General Access - IT"},"value":{"description":"ID of the required Role.","type":"string","example":"ac1301737f901991817f90d9ed110387"},"$ref":{"description":"URI reference of the required Role resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9ed110387"}}},"permits":{"description":"Roles this role permits. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are allowed to support a business role.","type":"array","properties":{"displayName":{"description":"Display name of the permitted Role.","type":"string","example":"Accounts Payable Access - IT"},"value":{"description":"ID of the permitted Role.","type":"string","example":"ac1301737f901991817f90d9ed170388"},"$ref":{"description":"URI reference of the permitted Role resource.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9ed170388"}}},"classifications":{"description":"Classifications of this Role.","type":"array","example":[{"effective":false,"source":"UI","classification":{"displayName":"Special2","origin":"JDBCDirectDemoData","name":"Special2"}},{"effective":false,"source":"UI","classification":{"displayName":"Special7","origin":"JDBCDirectDemoData","name":"Special7"}}],"properties":{"source":{"description":"The source of the ObjectClassification.","type":"string"},"effective":{"description":"Flag indicating this is an effective Classification.","type":"boolean"},"classification":{"description":"Classification of this Object.","type":"object","properties":{"name":{"description":"The name of the Classification.","type":"string"},"displayName":{"description":"The displayName of the Classification.","type":"string"},"origin":{"description":"The origin of the Classification.","type":"string"},"type":{"description":"The type of the Classification. This can be used to group Classifications in/across different origins.","type":"string"}}}}},"meta":{"description":"Metadata of the SCIM resource.","properties":{"created":{"description":"Datetime this Role was created.","type":"string","format":"date-time","example":"2022-02-11T01:34:04.074-05:00"},"location":{"description":"The location of the SCIM resource.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Roles/c0b4568a4fe7458c434ee77d1fbt156b"},"lastModified":{"description":"Datetime the Role was last modified.","type":"string","format":"date-time","example":"2022-02-11T01:08:45.866-05:00"},"version":{"description":"The version of the SCIM resource.","type":"string","example":"W/\\\"1644561244074\\\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"Role"}}},"schemas":{"description":"The schemas involved in the SCIM resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:sailpoint:1.0:Role"]}}}}}}}}}},"method":"get","path":"/Roles","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns all Role resources.","description":{"content":"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.","type":"text/plain"},"url":{"path":["Roles"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"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\"","type":"text/plain"},"key":"filter","value":""},{"disabled":false,"description":{"content":"Allows sorting the results by a resource's attributes.<br/><br/>**Example**: sortBy=\"name\"","type":"text/plain"},"key":"sortBy","value":""},{"disabled":false,"description":{"content":"Determines what order to sort results in.<br/><br/>**Example**: sortOrder=\"descending\"","type":"text/plain"},"key":"sortOrder","value":""},{"disabled":false,"description":{"content":"Determines the starting index of the result set.<br/><br/>**Example**: startIndex=1100","type":"text/plain"},"key":"startIndex","value":""},{"disabled":false,"description":{"content":"Specifies the number of results per page.<br/><br/>**Example**: count=10","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}}
sidebar_class_name: "get api-method"
info_path: iiq/api/identityiq-scim-rest-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns all Role resources.' (get-roles)"
---

import ApiTabs from "@theme/ApiTabs";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import TabItem from "@theme/TabItem";

## Returns all Role resources.



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.

<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Query Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filter","schema":{"type":"string"},"description":"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\""}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sortBy","schema":{"type":"string"},"description":"Allows sorting the results by a resource's attributes.<br/><br/>**Example**: sortBy=\"name\""}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sortOrder","schema":{"type":"string"},"description":"Determines what order to sort results in.<br/><br/>**Example**: sortOrder=\"descending\""}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"startIndex","schema":{"type":"integer"},"description":"Determines the starting index of the result set.<br/><br/>**Example**: startIndex=1100"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","schema":{"type":"integer"},"description":"Specifies the number of results per page.<br/><br/>**Example**: count=10"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"attributes","schema":{"type":"string"},"description":"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."}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"excludedAttributes","schema":{"type":"string"},"description":"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."}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Returns all SCIM Role resources.

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"totalResults"} required={false} deprecated={undefined} schemaDescription={"Number of Role resources returned"} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"startIndex"} required={false} deprecated={undefined} schemaDescription={"The starting index of the resource set list. Can be specified with startIndex query parameter."} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"schemas"} required={false} deprecated={undefined} schemaDescription={"SCIM Schema used for response."} schemaName={"string[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>Resources</strong><span style={{"opacity":"0.6"}}> undefined[]</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={"IIQ ID of the Role."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"Unique name for the Role. This name MUST be unique across the entire set of Roles."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"descriptions"} required={false} deprecated={undefined} schemaDescription={"A list of localized descriptions of the Role."} schemaName={"array"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"The type of the Role."} schemaName={"object"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"displayableName"} required={false} deprecated={undefined} schemaDescription={"Displayable name of the Role."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"active"} required={false} deprecated={undefined} schemaDescription={"Flag to indicate this Role is enabled or active."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"activationDate"} required={false} deprecated={undefined} schemaDescription={"The date the Role will turn from inactive/disabled to active/enabled."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"deactivationDate"} required={false} deprecated={undefined} schemaDescription={"The date the Role will turn from active/enabled to inactive/disabled."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>owner</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The owner of the Role.

</div><SchemaItem collapsible={false} name={"displayName"} required={false} deprecated={undefined} schemaDescription={"Display name of the Role owner."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} deprecated={undefined} schemaDescription={"ID of the Role owner."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"$ref"} required={false} deprecated={undefined} schemaDescription={"URI reference of the Role owner resource."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>inheritance</strong><span style={{"opacity":"0.6"}}> array</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Parent Roles this role inherits from.

</div><SchemaItem collapsible={false} name={"displayName"} required={false} deprecated={undefined} schemaDescription={"Display name of the parent Role."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} deprecated={undefined} schemaDescription={"ID of the parent Role."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"$ref"} required={false} deprecated={undefined} schemaDescription={"URI reference of the parent Role resource."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>requirements</strong><span style={{"opacity":"0.6"}}> array</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Roles this role requires. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are required to support a business role.

</div><SchemaItem collapsible={false} name={"displayName"} required={false} deprecated={undefined} schemaDescription={"Display name of the required Role."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} deprecated={undefined} schemaDescription={"ID of the required Role."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"$ref"} required={false} deprecated={undefined} schemaDescription={"URI reference of the required Role resource."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>permits</strong><span style={{"opacity":"0.6"}}> array</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Roles this role permits. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are allowed to support a business role.

</div><SchemaItem collapsible={false} name={"displayName"} required={false} deprecated={undefined} schemaDescription={"Display name of the permitted Role."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} deprecated={undefined} schemaDescription={"ID of the permitted Role."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"$ref"} required={false} deprecated={undefined} schemaDescription={"URI reference of the permitted Role resource."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>classifications</strong><span style={{"opacity":"0.6"}}> array</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Classifications of this Role.

</div><SchemaItem collapsible={false} name={"source"} required={false} deprecated={undefined} schemaDescription={"The source of the ObjectClassification."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"effective"} required={false} deprecated={undefined} schemaDescription={"Flag indicating this is an effective Classification."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>classification</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Classification of this Object.

</div><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"The name of the Classification."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} deprecated={undefined} schemaDescription={"The displayName of the Classification."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"origin"} required={false} deprecated={undefined} schemaDescription={"The origin of the Classification."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"The type of the Classification. This can be used to group Classifications in/across different origins."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>meta</strong><span style={{"opacity":"0.6"}}> </span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Metadata of the SCIM resource.

</div><SchemaItem collapsible={false} name={"created"} required={false} deprecated={undefined} schemaDescription={"Datetime this Role was created."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={false} deprecated={undefined} schemaDescription={"The location of the SCIM resource."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"lastModified"} required={false} deprecated={undefined} schemaDescription={"Datetime the Role was last modified."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} deprecated={undefined} schemaDescription={"The version of the SCIM resource."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"resourceType"} required={false} deprecated={undefined} schemaDescription={"The SCIM resource type."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"schemas"} required={false} deprecated={undefined} schemaDescription={"The schemas involved in the SCIM resource."} schemaName={"string[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"totalResults\": \"18,\",\n  \"startIndex\": 1,\n  \"schemas\": [\n    \"urn:ietf:params:scim:api:messages:2.0:ListResponse\"\n  ],\n  \"Resources\": [\n    {\n      \"id\": \"c0b4568a4fe7458c434ee77d1fbt156b\",\n      \"name\": \"ADDirect-Production Manager\",\n      \"descriptions\": [\n        {\n          \"locale\": \"en_US\",\n          \"value\": \"Directs production operations and processes for a plant, division, or company. Plans and maintains production schedules. Manages facilities and equipment maintenance.\"\n        }\n      ],\n      \"type\": {\n        \"iiq\": false,\n        \"requirements\": false,\n        \"permits\": false,\n        \"displayName\": \"IT\",\n        \"manualAssignment\": false,\n        \"name\": \"it\",\n        \"autoAssignment\": false,\n        \"assignmentSelector\": false\n      },\n      \"displayableName\": \"Staging Test Engineer - IT\",\n      \"active\": true,\n      \"activationDate\": \"2022-02-11T01:08:45.866-05:00\",\n      \"deactivationDate\": \"2022-02-11T01:08:45.866-05:00\",\n      \"owner\": {\n        \"displayName\": \"Lori Ferguson\",\n        \"value\": \"ac1301737f901991817f90d9eb050372\",\n        \"$ref\": \"http://localhost:8080/identityiq/scim/v2/Users/ac1301737f901991817f90d9eb050372\"\n      },\n      \"inheritance\": [\n        null\n      ],\n      \"requirements\": [\n        null\n      ],\n      \"permits\": [\n        null\n      ],\n      \"classifications\": [\n        {\n          \"effective\": false,\n          \"source\": \"UI\",\n          \"classification\": {\n            \"displayName\": \"Special2\",\n            \"origin\": \"JDBCDirectDemoData\",\n            \"name\": \"Special2\"\n          }\n        },\n        {\n          \"effective\": false,\n          \"source\": \"UI\",\n          \"classification\": {\n            \"displayName\": \"Special7\",\n            \"origin\": \"JDBCDirectDemoData\",\n            \"name\": \"Special7\"\n          }\n        }\n      ],\n      \"meta\": {\n        \"created\": \"2022-02-11T01:34:04.074-05:00\",\n        \"location\": \"http://localhost:8080/iiq/scim/v2/Roles/c0b4568a4fe7458c434ee77d1fbt156b\",\n        \"lastModified\": \"2022-02-11T01:08:45.866-05:00\",\n        \"version\": \"W/\\\\\\\"1644561244074\\\\\\\"\",\n        \"resourceType\": \"Role\"\n      },\n      \"schemas\": [\n        \"urn:ietf:params:scim:schemas:sailpoint:1.0:Role\"\n      ]\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem><TabItem label={"application/scim+json"} value={"application/scim+json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"totalResults"} required={false} deprecated={undefined} schemaDescription={"Number of Role resources returned."} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"startIndex"} required={false} deprecated={undefined} schemaDescription={"The starting index of the resource set list. Can be specified with startIndex query parameter."} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"schemas"} required={false} deprecated={undefined} schemaDescription={"SCIM Schema used for response."} schemaName={"string[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>Resources</strong><span style={{"opacity":"0.6"}}> undefined[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The SCIM resources returned for this endpoint.

</div><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={"IIQ ID of the Role."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"Unique name for the Role. This name MUST be unique across the entire set of Roles."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"descriptions"} required={false} deprecated={undefined} schemaDescription={"A list of localized descriptions of the Role."} schemaName={"array"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"The type of the Role."} schemaName={"object"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"displayableName"} required={false} deprecated={undefined} schemaDescription={"Displayable name of the Role."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"active"} required={false} deprecated={undefined} schemaDescription={"Flag to indicate this Role is enabled or active."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"activationDate"} required={false} deprecated={undefined} schemaDescription={"The date the Role will turn from inactive/disabled to active/enabled."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"deactivationDate"} required={false} deprecated={undefined} schemaDescription={"The date the Role will turn from active/enabled to inactive/disabled."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>owner</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The owner of the Role.

</div><SchemaItem collapsible={false} name={"displayName"} required={false} deprecated={undefined} schemaDescription={"Display name of the Role owner."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} deprecated={undefined} schemaDescription={"ID of the Role owner."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"$ref"} required={false} deprecated={undefined} schemaDescription={"URI reference of the Role owner resource."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>inheritance</strong><span style={{"opacity":"0.6"}}> array</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Parent Roles this role inherits from.

</div><SchemaItem collapsible={false} name={"displayName"} required={false} deprecated={undefined} schemaDescription={"Display name of the parent Role."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} deprecated={undefined} schemaDescription={"ID of the parent Role."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"$ref"} required={false} deprecated={undefined} schemaDescription={"URI reference of the parent Role resource."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>requirements</strong><span style={{"opacity":"0.6"}}> array</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Roles this role requires. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are required to support a business role.

</div><SchemaItem collapsible={false} name={"displayName"} required={false} deprecated={undefined} schemaDescription={"Display name of the required Role."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} deprecated={undefined} schemaDescription={"ID of the required Role."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"$ref"} required={false} deprecated={undefined} schemaDescription={"URI reference of the required Role resource."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>permits</strong><span style={{"opacity":"0.6"}}> array</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Roles this role permits. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are allowed to support a business role.

</div><SchemaItem collapsible={false} name={"displayName"} required={false} deprecated={undefined} schemaDescription={"Display name of the permitted Role."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} deprecated={undefined} schemaDescription={"ID of the permitted Role."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"$ref"} required={false} deprecated={undefined} schemaDescription={"URI reference of the permitted Role resource."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>classifications</strong><span style={{"opacity":"0.6"}}> array</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Classifications of this Role.

</div><SchemaItem collapsible={false} name={"source"} required={false} deprecated={undefined} schemaDescription={"The source of the ObjectClassification."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"effective"} required={false} deprecated={undefined} schemaDescription={"Flag indicating this is an effective Classification."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>classification</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Classification of this Object.

</div><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"The name of the Classification."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} deprecated={undefined} schemaDescription={"The displayName of the Classification."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"origin"} required={false} deprecated={undefined} schemaDescription={"The origin of the Classification."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"The type of the Classification. This can be used to group Classifications in/across different origins."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>meta</strong><span style={{"opacity":"0.6"}}> </span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Metadata of the SCIM resource.

</div><SchemaItem collapsible={false} name={"created"} required={false} deprecated={undefined} schemaDescription={"Datetime this Role was created."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={false} deprecated={undefined} schemaDescription={"The location of the SCIM resource."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"lastModified"} required={false} deprecated={undefined} schemaDescription={"Datetime the Role was last modified."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} deprecated={undefined} schemaDescription={"The version of the SCIM resource."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"resourceType"} required={false} deprecated={undefined} schemaDescription={"The SCIM resource type."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"schemas"} required={false} deprecated={undefined} schemaDescription={"The schemas involved in the SCIM resource."} schemaName={"string[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"totalResults\": \"1500,\",\n  \"startIndex\": 1,\n  \"schemas\": [\n    \"urn:ietf:params:scim:api:messages:2.0:ListResponse\"\n  ],\n  \"Resources\": [\n    {\n      \"id\": \"c0b4568a4fe7458c434ee77d1fbt156b\",\n      \"name\": \"ADDirect-Production Manager\",\n      \"descriptions\": [\n        {\n          \"locale\": \"en_US\",\n          \"value\": \"Directs production operations and processes for a plant, division, or company. Plans and maintains production schedules. Manages facilities and equipment maintenance.\"\n        }\n      ],\n      \"type\": {\n        \"iiq\": false,\n        \"requirements\": false,\n        \"permits\": false,\n        \"displayName\": \"IT\",\n        \"manualAssignment\": false,\n        \"name\": \"it\",\n        \"autoAssignment\": false,\n        \"assignmentSelector\": false\n      },\n      \"displayableName\": \"Staging Test Engineer - IT\",\n      \"active\": true,\n      \"activationDate\": \"2022-02-11T01:08:45.866-05:00\",\n      \"deactivationDate\": \"2022-02-11T01:08:45.866-05:00\",\n      \"owner\": {\n        \"displayName\": \"Lori Ferguson\",\n        \"value\": \"ac1301737f901991817f90d9eb050372\",\n        \"$ref\": \"http://localhost:8080/identityiq/scim/v2/Users/ac1301737f901991817f90d9eb050372\"\n      },\n      \"inheritance\": [\n        null\n      ],\n      \"requirements\": [\n        null\n      ],\n      \"permits\": [\n        null\n      ],\n      \"classifications\": [\n        {\n          \"effective\": false,\n          \"source\": \"UI\",\n          \"classification\": {\n            \"displayName\": \"Special2\",\n            \"origin\": \"JDBCDirectDemoData\",\n            \"name\": \"Special2\"\n          }\n        },\n        {\n          \"effective\": false,\n          \"source\": \"UI\",\n          \"classification\": {\n            \"displayName\": \"Special7\",\n            \"origin\": \"JDBCDirectDemoData\",\n            \"name\": \"Special7\"\n          }\n        }\n      ],\n      \"meta\": {\n        \"created\": \"2022-02-11T01:34:04.074-05:00\",\n        \"location\": \"http://localhost:8080/iiq/scim/v2/Roles/c0b4568a4fe7458c434ee77d1fbt156b\",\n        \"lastModified\": \"2022-02-11T01:08:45.866-05:00\",\n        \"version\": \"W/\\\\\\\"1644561244074\\\\\\\"\",\n        \"resourceType\": \"Role\"\n      },\n      \"schemas\": [\n        \"urn:ietf:params:scim:schemas:sailpoint:1.0:Role\"\n      ]\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>