developer.sailpoint.com/docs/api/beta/get-entitlement-changes-identities.api.mdx

---
id: get-entitlement-changes-identities
sidebar_label: Get identities for a suggested entitlement (for a role)
hide_title: true
hide_table_of_contents: true
api: eJztXOtz2zYS/1cw7IcmGlGyZTuuPXNzozhJ60za+Py43IzjmUIkKCElARYg4+g8+t9vdwG+JPkRJ9NrWn1pLBJY7Bu/BRe9CXQuDC+kVsdxcBhMRfFSFbJIRSZUcTTjairscSzwmRQ26AcFn9rg8DI41algx8rK6aywwVU/iIWNjMyRFBCi19K/ZracAh34QzTELSs0mwjG41jELNGGcWZg1oCdzySOjHMtVcGMKEqjLLxNpS2YTpis+YEVWDETNK/PrmUxY0AH/9VlQW/aC/b9Kp4bWLX1llkNE7ibVVphWMQVs0Kw65mMZu1Fr3WZxsR6kogI6ciEpq0nfC2M6Mha6JrpAWg054ZnohAG9XoTSFRfzosZvFLwAn55PYKF+oGNZiLjweFNUMxzfGkLI9U0WPQDI34vpRFgx8KUYtki537JyiogEZATn3iWp0jnh2j7YEs82w9/2Oc83BXxQcgPtiZhfBDv7ezu7o12kgmsspbBlrhfzmRbd1/E4++lMPOGyRm3Ld8Olpf2Xj5nMA7sIzvOim6lNE5q+E94akEAW8yJN/CtjJjNUx2LSrwVTUw02IArWj7hZVp4Qovb2NZJYsUqu2/pMRjTe1NSpinEigWK4LXFgF3YkqfpnNlcRDKR4HcUH71UZrLooRPmfCoVL8A5Z0aX05nzSiJhB+/VGfj+5b932PjkmJ0VXMXcxOxIpyn4PPDATmq/vXoyK4rcHg6HsfgoUkwpA8tlSgE8iHQ2lLEa8lwOracTRjWdsPH/pxSgmTbopKhPSkyDdVqvfWJrjY5hVTEVBuY5Iu7RzggeZFLJrMxoXm2ArVuVT8pa0f3P/BNTZTaBJAHpyGsMNepy1Teju9HeF2gv45/c30Sl1iX8ulWbkS7XBV7CehgsPSYhWUpw41znZeocU7Def8JzXfA0PMLZPVR3rpUVbCZ4LFy2p4FrLIL5vM7WzjguW1dRABplPRdhPZeo5VSBDmOwIVhRqgjngRi2gPwFe0eBrDAShDaIGf8IaZ2B1UhZOF5mOY+KPkoDScQIsCGkEEz8kEHQS6zAVXtE5B8kec/tIMDtR56WwmkBR09oL/LcfBM+9bXSntWGtsRlbzmD57WBS4tWoa23UoidqwLC002aoLXVH6y175B14Cv0XD4l47ln6BG2zHMUzoEeyt1ARl/ja8jTaWwPwTtQDb1eZ/cjzXz5DlTtxbdpPpHpWs2/oud/ct075pe1/6p6+jD9U1pwwFgbe4gUKoOAaez1qlmYvWbvg9dcvQ++poWukJZLdxbfj7a28J+liCijSAjILwN2ehdWvgceY1hHGnI/pGhYg+d5KiMK+OEHiwvdrDLKjeHoObIQmW0915MPYBrEtgbVSKUDvAU0tyLkKgwjs3i+5wgZnV/eN/EXNMPyVF7A4ElZiLXcARyXOJunJx0+l82waJnbSfEwJFqH1DjmGTuDHQcxc5enWID3FoRID4OfSthCwIpWlyYSNiz4LMymQFUhDk6kscUvDUV49EFPztGA6AY8BSOPQZi5ReFS7ayHeEV8kpHGiA8KPxrrs6p6a9V3iwVJu7vOz45SiUj4pTGg5ND7WlP8+G2STXQ8xzCTCvYyGT/GrW5xn1gUkBKOKHLu84ZXUolwarhEDgWxHMFEBhQ/yhhDnbY1RxIDhaIBxw06wQ2aGGyz5zwGeZ18R14YVKbh0W9A6/gBfn2hJMxn1RTw0jr9rFlW7As+ebZ1MNpNnu1yPvphd3t/b3KQ8J2drYO9gwNcPRPW8mnHY6t47C79o1CQ/CKGHpHK/4JCjOCge2KAFn94CBONB+gfCzk3thbT88sK8QnQEWfPj07Y7j5LuZqW9JxPl5SgwoszDCIobfikAheLvmfirZFTqdaxIhTi0svgxctX44s35/Dk9OW/Ll6ewV9Ia+WwYqzAW2N0S034caaviWMvwDUUhFakVOoPWM9T7YFAXNn2QOl+WQhAkTEPdGCGX33NjDZplhiddUKJ4uZTwZ7IgRj0AQzCM8Bg0YxNOKBCpt3pR28MG0BehG+8JnseGj8dsHGd4RyytDB/3pxE+OOTpIRQFvXGAMBTRqJri0aVXWs0GeVN2ygYHMD5/X4yjgooU8knOlFYe4tn0dsHeHaa63J33lIaqRSBCGCDiCrgSBtA4ZCZQDYJyMWnI8ICkHhUNa7OWO1ESenuZ8fMi8Il0YiX9gFxd5JC+glJtPrFR+GDj+pFl43IGpWZfEbyVT1N9qNqc1WB79DKJnY3sbuJ3QfG7vLLU4+u/VuCPtur0OdC8RL0a2jzXIE+hrxHaVYNInjjDdlHyO0h0ut35xDYvwmF46EIwBrhK+Ijt5WvMD+u7eELs6puq7b+xhbIIOnRSZBAJhLxIfHdcOxAIqlqZ3W1V9pMJDioWgMR6Vh9rkvGQWWmVIrOVGyfxVpY9X3hT1MgIqx1GdB9CAhdGbhBkhskudmNNrvRX2Y32iDJTexuYvfbjN07kWTNFUWLx0m2zDJu5s7T/HuUljMY0HzWqkOOTLWMVpAYqzFW0EUOwWS0PdlO9iOxG/Pd+NnOQTKKno343v72/vZkd7QftPf6yyaO6yDrxlTL3s6OpGIAcR8Bx5UKnMsWWsfd478SP88kmNYw9dS4GXQOKr2qsOPeuhPGY7CIQS89c0vcctTo8DZXwAJAUhc1NfLZIMQNQtzsMptd5q+xy2wQ4iZ2N7H7bcbuZyBEj4ZuR4gw4MEIEcYOtliNpV5Rt80fDRQpVDwH5N5MR1Fp6MCzQoGEK8CVfOMx5hDsKj0MhtinGlbdw8Obuv91MWw1LISRa08e3nTaTxdD2e5XdmjVSVGaFKhXnSY3YFww6mLAczmomgaUvqZ2kwlodE2ywu/aLjBxADW2uAUGZA4j0eNdeiTizji+4SmoO1rupEz9JGD1uS4hIRKZPoPo8N5Hj4HFnKv595ZGD8jbVuQDuS5MuvhyWRyhW2RZp747V4PxDDhdEhFFuEJzgZdg8wba6wL4OXK5bVyiZ1xetcecIZZ3HK6MbPYnrEBGKwy9xWEj9lxwA4WGO5R/8vrd+VM2RQRLGcR1OAmJJQfE4Am4EWXIcXVAjZNo02raZ8edTwAYkSxJQSnM9+9VXca/wNZxCrme1I6TBKUXnPXwXijemXdLt957FbIX0rhWKUtjvIiuo/Eyr+TiLbkey8R3FbXQUQuJGnZhdbhwqr2MXEtJBGkBSfDUkrYevbijF7boYV0GT5DqMg+oCc9H98NNVFnt0Xx06IVIr8vHe/WOLhV0pzGXDZmdUcvqMYtmWlvxT8bQdTBULqclRNqj2aKbDCFFRDjaarEUuiVDGQLYJP7eQGAo50x8gps9YR0NMFDFLmx/JctCXviV2uV+7chMjy9hT8aRsY4+o8FviWdcMMQFQ5cnrOffbXnoWNgZBTJQHnAOcNTYnzKBZ7SVGx2ttZmfyA9pDm4fEbBKVGx+6H4cNknQ/8XoBY6ux0CqRqxef8qC38zTwn2vo6zqlGFZg6v8phq22yW9OX7rcxbcgv9s8qLE4+Yw5q1K5187S9+SSf48eff/lPE2meavmGk8ekZ3o2V9mdF28uce060eDlq6VwH/hbcUqwTUoQxqrlK0CeUpL9CrKaqjmRR0rJALXiA+7KNn6YwiMTcaw79qNZ4aGANhawG38olMgR7e7atX5hQwDnyiXfG3Lam2wbUcuh+wd9ilHIFZsMrD5gF490H7cu8MLHNC1wRfVMYG0JVlpcKbXMB2mTEOLnWPR8TSRqVLXFD0KVHpQhP0q2dVUYyuhiIMqN4xmX2b4Ik1FMMtw9+zFtjd+uNqUD1a0fcKN4KcipQ8E8d1of19tMHbwplIc6wzIesCABOtFX4+Pl+hCMSU6zoeaDMd+kl2iGOBCJZQzn12BtuDrZBKCniea1tAZdwi/iNeSmuazu+6cfmkufT5dNlNb5qD/M1d0offJfXbKdZBwxyPBNFIpavdXHF9GXSKa5hz2L5euqa+xiHLFzxbJTYUZDPwAqR8c4PnTVhzLvCxu1eChRz4JSaL5kLErbZ+4C3MtXL+JvDoZOWapz8lCehi6MM5+XtdsLxDofUF1Ecq8tu6LXmHIqrLoI/Uw+ae47d3z/EOb6gusz7SG/529xjvUGVz1/ORytxcTWxfTbxD083dzkbTV81p72du1k9O/UXHp+x87f9dYi0n1XdMNW+zUXHYgJHPc4ElXlb+JxKPYKULehZXMMHlYlKTG+M+qbVmrzSdoH7rzxw/vgQ4vfgfpvt0rg==
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 identities for a suggested entitlement (for a role)' (get-entitlement-changes-identities)"
---

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 identities for a suggested entitlement (for a role)</h1>

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



Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the 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><ParamsItem className={"paramsItem"} param={{"in":"path","name":"entitlementId","schema":{"type":"string"},"required":true,"description":"The entitlement 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":"hasEntitlement","description":"Identity has this entitlement or not","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"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.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem><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: **name**","example":"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*","example":"name sw \"Jan\"","required":false,"style":"form","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 identities with or without the entitlement.

</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={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Id for identity"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name for identity"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></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    \"id\": \"8c190e67-87aa-4ed9-a90b-d9d5344523fb\",\n    \"name\": \"Adam Smith\",\n    \"attributes\": {\n      \"department\": \"Human Resources-tah-mgb-dnd\",\n      \"firstName\": \"Adam\",\n      \"jobTitle\": \"Sales Analyst\",\n      \"location\": \"Mexico\"\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>