developer.sailpoint.com/docs/api/beta/get-role-insights-entitlements-changes.api.mdx

---
id: get-role-insights-entitlements-changes
sidebar_label: Get entitlement insights for a role
hide_title: true
hide_table_of_contents: true
api: eJztW1tzEzkW/iuqnoeBVNp2boTkZcskYSpTDGRzWR6SVCF3y7agLfVI6gRPKv99zzlS33whhmV3Gco8AG5J536+c6RWP0Q6F4Y7qdVpGh1GI+HOdSZOlZWjsbMnykmXiYlQzh6NuRoJG21Gjo9sdHgd4UxWTo1uN6NU2MTIHKkBrcuxtEyoNNdSOWaEK4zCBxVJJsNaNtSGcWaAXgfo59zwiXDCIJeHSCKxnLsxDCkYgF9hIYi8GdlkLCY8OnyI3DTHQeuMVKPocTMy4s9CGgGKOVOIefkEsSzFYBLJic98kmdI52WyddATL/bjl/ucx7siPYj5QW8Qpwfp3s7u7t72znAAXIKAfxbCTGsJrTakwCzTC3gOtrBFBmoXFgRlDuSwjquUm5TZqXL8M/OLBiIF4dj1v3ZY/+yUXZSTjnSWiQQpsrPKVrfPxs7l9rDbTcWdyNCvHctlRubvJHrSlanq8lx2S2ZxUtGJa5v/gqKDXHGQ8vmNulEX/hkDj9oiz1G5lLyGwg+BjL7H4aEUWWoP2caGTMnRUtj30o37SSKs3WRonI2NqOmZIc8suMa6KRkdaE7IC3mmU1E6bqmPl5l/KLOF5n9Nz39wB3jhZ13wuny6mhMYsGA+ubWxh0hhY8PbH/xj7zf8k4Z5yoGV3FMmCVJk9p7dRP10ItVN9DXOu0VONtfKAq7A+Havh//MZEwBwSNSkXbYecAQzjJpHdPDJppY5jQbCMbTNJilRpREKwdTkDjP80wmhHjdjxY5PMxLyI3hGE3SiYltPNeDj+AuhCiDpsXwxlEfdLP6zcbeWzQVyIzeasiNQAXI8+Ty03TJ4ta0p6gc17+q0Jmhxx0sHRRuBZX65dRltO54VnwVHVqwjJrVhUlWIHdB81gg0vD4MsKhAswHH9aIT1KR6csy4bCuSZ9gVk8IOxzVxS8GiR99SnRkqIrJAEAKWVYoijBEjKli3QOmzurRaeVl//jYB9Y8DDeEAGASI2H+W1K83Ou1ZDid5DxxIv1uErgxdyzVTGnHxvxOeCjPRSIBBNOlcm2RXE47nr0lHu+GpxWHFYWj1QtFbLPq9XqPyAwFgaXN7ir8Gy0bb3RfZfP1iH82o91FQHmUSWyqToyBII8DWGIB86iBmC4ANQc6nWL4SgW5JtNvgcclEZ4KB+XuiKD/qTh/LZWIR4ZLlFCQyAksZEDxTqZYxibaCOZJVsCH89pxDpbobLFXPAV9vX5HQRk0quEJZO/odAV4vVIS1rNyCfizBot5tmJf8MGL3sH27vDFLufbL3e39vcGB0O+s9M72Ds4QO4TyDU+agVUWVfarH8TCgp7wjKdgEf+AoMYwW1AK2K+eikiGivijJ9bqRnkZU58dptQPF8dnbHdfZZB5BX0nI9mjKDiqwvsuYos44MsFHzQ3BN+Z+RILixJAtIGNxDHJ6/7V28u4cn5yT+vTi7gf0hrbifRVxCtKYalplwb63uSOChwz6EhEthIYZOwEahugEIcmoXGROl/2akFY0JsDTl0V7AicF+wokmaDY2etFKJ8uazY89kR3Q2ofmAZxPukjEbcAsLtKLpG4i7uYvfBEtusLHgqTDPO6yfphKVBCihymdh/bTuYqQnMCwglT3e6sIh2slEtH1Rm7LtjRpZ3jSdgskBkq9QmRNXgHCkZjMLq2gJIgb/gMzecm3pLhtGI5Nikw19L8zMpmBGY8DCDBoAJqGPC3BEfS4AjyrnVYjVBEyCuz+8MMdO01jCC7tC3p1lAD8xqVYN3ImQfNROejQib5RuCogEg6g2LQ6zKneVie878XXurnN3nbsr5u7s4HnYHoZRan225lufK8ULsK+h4jnX+hiKHqVZOcnvBbwjN3GbEFqk399fQmJ/Egrnwy4Wt8DfsT/ypXxO+H7lj3DoUJ5JlKW/9gUKSHYMuxlAIpEekty1xL5JJFPtzHN7rc1AQoCqBS0ioKZhU10wDiYzhVIoCbeb0GILq34NPTanXYRHQH/CF/sjjnUnue4k19VoXY1+mmq07iTXubvO3b9n7n6xk6ykomwJfZItJhNupj7SwjhqyxlMYOWLClalXHW23exWkBireqyo3TlEg+2twdZwPxG7Kd9NX+wcDLeTF9t8b39rf2uwu70fNWv9dZ3HVZK1c6rhb+9HMjE0cXfQxxUKgss6rdP28V+B7x+HCGsIPVXfDDYHk96WvePeohPGU/CIwSi98CyWHDX6fpsrEAFaUp81Veez7hDXHeK6yqyrzM9RZdYd4jp317n798zdr+gQQze0vEOECSt3iDC302NVL/Uag+t/3ihSqgQJKLyZTpLC0IFn2QVSXwGhFC4GIobgLbzDqIsv3+Py9l73obqO99htvHKPk+rGoG9JvaiFyYBEeVXqATwInnvs8Fx2wjv0qdL3dF9qAGZbgEj++gVGE06gm1meQYdsbiSGtcdAIu49QFpiAJdXsr5IWYXLOlNdAOoRmU0GKRBCjB6DiDlX018tze5QSM3pB3pdmezxP9fFE1qiyyLzfZEbzGcg6YyKqMItugtCAQiRv65AniMPYP0C3X9925xzgQ27l3BuZl2EcJuxPSfQO5y2zV4JbmA34U/en/3+/vI5G2GbSjDhr+gJifsKSLQzCCOCwX55Co2LqDIZXYz8fZR+65wf044NMzAKu1EXQrDrcNlj+hbqwzkAOpkdFwnCEFy1+mU+3lr3nMok7Sekwtty9LRzo2J2LI2/6+fvuwYV6YidXeelXryh17cK8UtJLfbUYqKG1whbUnjTXif+3kgCuY8keGbJWt/M3NOLG/Rw8wVPkOqsDGiJIEf77UxSeu2b5WjRi5FeW44b9X4soQa3lzEPecxCCc1SdsqSsdZW/IMxDB1MletRAZn2zWLdI9OYMiLe7jVEij3LWMbQUZJ8byAxlA8mPsCKTg2Nhl5PpT5tP5BnARc+0HW0Dy2d6fE1FF6cmerkK26ozsiMDGNkGHucsEF+X9cwsCC3UQfCAR8AR7X/CQmCoA1s9LQWIj+R79IaLB8JiEpUbH7ofxzWIBj+x2gAZ1dzAKqxIa/eV8FvFmhhcWsZqzxKmLXgvLyZhpo6Yzcvb3WYgnX2R9MXNe7XJy7vVDb93ii9BEl+HNz9PyHeGml+RqQJLTKGG7ENe4lmkL8KPd38CaClu6rwN4xSrlI3Dnud+lZtk1CecYdRTVmdjKWgs4NccIf94SZGlp5QJsI2H9MfdohEaGRgDqSthb6VD2QG9DrssubMKWF884l+xd+2oA0M8vItfIe9x0u+CbgFt3J4QwDGPuqwp7sAz5zRRz7HpbOh6ZpMCgXcMC+LCeMQUk9ERCptUnjggp2dEqUtNLV+1aoyizHUUIUObWrMxL4b4rG0xAvi0Yq8wO82nEmD6eur/FGtyLnIKDJxXru1f4o2RFs8FlmOm0lAXWjARIPDH6eXcxSBmPJ33DvajLphke3iXLxMD8r78NnpbHV6MW0p4HmurYPtb4P4b8I99aHVbEg+1Cfz3/7lVigkuAPo5njiheIVftfi947XUWvvCGsOmx9zLdo+wmZjDBri2ocHPDDB/dQjPvYf/eAmBWyOiVB/sLJUt/UHWPQB1kJPfRJ4tlF/uhbOLyL6ym11E68/slrpI6svuKD+fK12wW19HvCVIf/sPHzO9ZxdLvzmcaEk5XG2mjbFKCWsk/bxFib7g0qSy4/7o8zGyrmXfahQdbz02wkg3OO/AQe9nuc=
sidebar_class_name: "get api-method"
info_path: docs/api/beta/identitynow-beta-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 'Get entitlement insights for a role' (get-role-insights-entitlements-changes)"
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
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 Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Get entitlement insights for a role</h1>

<MethodEndpoint method={"get"} path={"/role-insights/{insightId}/entitlement-changes"}></MethodEndpoint>



This endpoint returns entitlement insights for a role.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"insightId","schema":{"type":"string"},"required":true,"description":"The role insight id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **identitiesWithAccess, name**","required":false,"style":"form","explode":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**name**: *sw*\n\n**description**: *sw*","required":false,"style":"form","example":"name sw \"Admin\"","explode":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Succeeded. Returns a list of entitlements to be added for a role.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the entitlement"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Id of the entitlement"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description for the entitlement"}}></SchemaItem><SchemaItem collapsible={false} name={"attribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Attribute for the entitlement"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Attribute value for the entitlement"}}></SchemaItem><SchemaItem collapsible={false} name={"source"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source or the application for the entitlement"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>insight</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The kind of insight this is and some stats

</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The number of identities in this role with the entitlement.","example":"ADD"}}></SchemaItem><SchemaItem collapsible={false} name={"identitiesWithAccess"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of identities in this role with the entitlement.","example":850}}></SchemaItem><SchemaItem collapsible={false} name={"identitiesImpacted"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of identities in this role that do not have the specified entitlement.","example":150}}></SchemaItem><SchemaItem collapsible={false} name={"totalNumberOfIdentities"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The total number of identities.","example":1000}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n  {\n    \"name\": \"string\",\n    \"id\": \"string\",\n    \"description\": \"string\",\n    \"attribute\": \"string\",\n    \"value\": \"string\",\n    \"source\": \"string\",\n    \"insight\": {\n      \"type\": \"ADD\",\n      \"identitiesWithAccess\": 850,\n      \"identitiesImpacted\": 150,\n      \"totalNumberOfIdentities\": 1000\n    }\n  }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Client Error - Returned if the request body is invalid.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n  \"detailCode\": \"403 Forbidden\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The server understood the request but refuses to authorize it.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal Server Error - Returned if there is an unexpected error.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n  \"detailCode\": \"500.0 Internal Fault\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"An internal fault occurred.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>