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

---
id: get-role-insights
sidebar_label: Get role insights
hide_title: true
hide_table_of_contents: true
api: eJztW21z2zYS/isY9kMbjSlL8lvtmZsbx046zqRNLrYvN+d4phAJSWgpgiXIODqP//s9uwApUpJt1cn0mp6+2BIILPZ9n4XA28BkKpeFNulZHBwFY1W8M4k6S60eTwobbAWFHNvg6CqgYVGPX28FsbJRrjNaioUXE23FVBUTE4tcFWWeWhGrQupEYYDWar9WjEwulIwmPNzFFpnMJZaqnDa6DTTR+61U+QzPUjzBVzMaWVUEi7u+4WGQLowoJkqMyiTB9rZMCoEHXXFpS5kkM2EzFemRBi83upiITqKnuugILMvkWKeyUFifm3I8YTqOhO1+SM+VElf/3BHHb8/EeSHTWOaxODFJoiLiQbyteb/+blIUmT3a3o7VR5WQXrsW8mcG7HUjM93WcbotM71tPZ0wqumEcx08YwVNTU4qw8cpW4f0lKvfSp0r2GkkE6u2AvVJTrME+ultBTaaqKkMjm6DYpaRyrCrGqsc6xwRN7QzwMBUp3paTnldrEYSsuLz3d3WauWzspZ0/6P8JNJyOlS5MKNKY6RRZ/6vRneDvc/Q3lR+cp+ZSq1LfLtXm5Ep02Vtno1Ep8hL1RG6gI/CjTOTlYlzTCU6/wovTCGT8IRWd0jdmUmtEhMlY1iAvZomrrDIRIKiKZNYDJU3DuJAj+oogEZFx0VYR9woUt44hQ5j2BBW1GlE6yCGLXQ6FhJGBiuCBRGRTMVEflQYhtVYWTRfTzMZFVskDRJDrmDDqUpjbJyagrzEKtq1w0T+xpJ3iCfm9qNMSuW0QLPBdmkrbr4KnyJ5VjjV0CDjyTRoeAqvZF/x7mFNzplwq+08bW85x6TawKUlq5DxK0GEnaUFwtMtGpK10z9Ya9+QHOAr9Fw+Y+O5MfIIW2YZSRqzdjl3g4y5ocfI00lsj+AdzpvfjC6zGJFg4U6xSgtdaGXfw+OPo0hZjLI//uTnntVTOp2gYZNggdgqA9pixlPJzLw2S0x8vz1tkYPfoGm+kU4eN99LnvQnN6CTZNGEL6vR9YzIucVBDJPbI6IAq2KLTgf2tTcdN2JuUpX/tDTc0Fr14PdbreEA2EDYG/EheGUm6YcgeMik17SRS7KWng96Pfq3EIclPFAhq3XFOw96pEi0LTgBI9ity8yNxCHk0JTFA2goMig9qBDYTGZZoiNetv2LpR1vlzmWeS7JxXShprYxboa/wKgEr3IyAAUEPdXxsrRLxcgxh2hrBVB/d/9A7fdVOBp8vxvu7hxG4VAO4D/7UdTvR6Pe4W4/uNtaCrRVVXUBPXJBmdeu0q30bkUFBMpp8rKHbaJcYVJ8ij+rRKrrNpEKCz1Vy9vCY+unc5NwCUwkrOi3aPPRbSll0Bv0wt5e2D+86O8c7R4e7Rx0d77f+zcpgrlecprjSpqHDeUSymOmYljOU5tMnZtRcSMhxYsU6FZB4+BmHcszuSeavUVprY2aQ80d3yL/IFJuJkb4JIZc40Winep0seY+PH9ZS8/NsKZ2tq5yHK0nqQh7oTDxgmaTRZ/ZPu77ssOQm/6qKZGOKid13qhdfrVmyqXD9WsPOpV7+pigFy0gOa+5VIXqMJhjTn6cKOC7oh0bx6enzvGWi/Y6SeHLcPE9sHiThzNGpir+YhwwZI0NQ1VGwlzJ64bzPr76zNc90GVN5oqFvDlnsb1Vr9e7z/v8//u8E+N39Gh3Vfk7STT2Ey/yHPkx9CXQ9Raui+aeQQxNPCNf1SmAvY6fUuTucWd3wnDC1f4xp36JRBiOc6mJQ8UsR1goQPGjjgmyMMZ3JEmZ7FQ0r+3U0ES3L57LGPI6+U68MKTBXEYI1fE66eQy1VgvqiUwXg2jVmyrDpQc7vcOB7uj/V0pkWf6B3vDw5Hc2ekd7h0e0u5TBJYct7ynQgftrX9QSGI6EomJYJH/0BGNkpRyGY3Q5usDCqaxZlJxc2sxPb+iUJ/QKkrx/OSt2D1A6U3HJY/L8YIS0vDynFrpMknksOq0ILkj/CbXY72y+KiUmvSr4PTFy+PL1xcYeffiH5cvzvGJaC0dZx2n8NaY3NJwYE3MDXPsBbiRKEiKQDNBv46n2oFAMrXNidp9szMLZQrf9WGF333FiiZpMcrNtBVKHDefCvGd7qruFjpjjAHlAD4OJVpkYVJ3XEBJNivC116THX9O8KwrjuNYk5DIG9xmW6yfUYst49j1Ge4gDaHskiuhVaQ2HS0An7kq29aYp5HXTaNQcIDzx/3kOCpKMMdiNqOw9hbPorcPeHaaa3N30VAaq5QaKvQ4ER8HRibPoWExJCQOxOfTEfc0SDxpNa/OWM3syOnuR8fMaWH4WSRLu0bcvU2QfkIWrX7wUfng48Mzl43YGpWZfEbyR5y82M+qzVUFvuu6NrG7id1N7K4Zu4sP3/mm3z9l6NNfhj6XqSyh35yL5xL0ydl7UiOqSa71d4bcElCIh0iv3l8gsH9VKc1XnzI61/iC+MiV8hUdaGUPf8BUnT9VpX9uC2KQ9egkGPEPOkfM95xjBxJZVTvLu700+VDDQdMVEBFZMxczUwpqVvMyTfmA2W4BTyubfusBteSWwWVA2jWNQ3ectUGSGyS5qUabavSXqUYbJLmJ3U3sfp2x+yCSrLniaPE4yZbTqcxnztP8c5JWCkyY/8ZfhxybahGtEDFRY6ygjRyC4aA/7I8OIrUby914f+dwNIj2B3LvoH/QH+4ODoJmrb+ax3EdZO2Yatjb2ZFVDBD3ETiuTOFctjAmbh//lfRb9YjSGqWeGjdD51DpdYUd91adMJ7BIjl56bnb4p6jRoe3ZQoWAEld1NTIZ4MQNwhxU2U2VeavUWU2CHETu5vY/Tpj93cgRI+G7keImLA2QsTcbk/UWOolXz38o4Eih4rngN1bmCgqcz7wrFAg4wq6Qx7wVXTKIbKY4Ms2/dIe6vm1dAc5HStlnmBKde3tFhaCZe66MtNd/4P4LDU3fPdtCLWsyDjuLgV5C03gW3Zugy7rNNfkti7HMXGnYX+FM6iv1z1ImW+fwXQzUyKrMZktARf3LsTDYDGT6exby7O77DJL8kGuyzy5+3xZHKF7ZFmlvgd3w3wBThdEJBGuyVwwNQixvS7Bz4lLUMclmffqujnnnAC543Bp5rzIUBsxWGLoDU0biOdK5ugW3Mn6d6/eXzwTY4KhnAbcdUulqW9AILnLRnDK4+qUmRZx5Zm/EHDcOsensBKjBEoR/kayv7kx+wn5/x0SNqudFinOEbRq/YuZsrXunvvHH9JQnOrc3dt0N+W8iO6O9lVWySUbcj2ViW8qaqGjFjI1uhLa4sKp9ipy90IixDaRkIllbT15c0cvbNCj5gojRHWRB9KE56P960tUWe3JfLTohUSvzceH9P1Eo8a2l1WvxdgJX8I/E9HEGKv+LgS5DoXK1bhEpD2ZrRvaNOSICAe9Bkuh2zLUIRAj8/cagZE6Z3L3UBmwGGC5NHZh+zNbFnnhZ75b9nNLZh6+QmGlmbGJfsdt4wWeacOQNgxdnrCef1e3yLEQ2yQD5wHnACdz+3Mm8Iw2cqOjtTLzM/ltXkPlIwKrTMVmR+7L0TwJ+k+CH9Dseg5SNQHu+vcofBeeFhWvlrKqo4JFDS7zmxjUzAW9OX7rwxKqo382eUni4/mJyps0mX3pLH1PJvnz5N3/UcbbZJq/YqbxEJjcjbf1vULTyZ97TLd8wmf54in+4inHKqNt9DLzK7JNQlkiC/JqjupoohWfDWRKFoQPt8izzJQjEW08hX/1LsOY78TnYFmim9MJ6HXFxXxnyQHjwCfZlb7bkhsU2iuaoNdUXfGebuxGMAu1anQDAM9+Mb5nO4dl3pJhxWllbICu6bRMsRvFZTkVEi71iEfE2kalS1zo3FJV6cIw9KtXVVFMrkYidLlpyaf2zYiOndHRNgz/yF6wu/VnzlD9/B5/MBfknUrYM2leG9o/RhveFk5UklGziKwLAKYaO/x4drFEEcRSC7nQlJt8vO0X2W2aCyLUQjn32en2u72QWwqMZ8YWaG8bxH9QRfs13kUHvJ2fs3/Wy8C+chDk387oCIv4KV2b4prBq6DdDKJ1mIBfenB7S8cb1B3d0bB7+4paDmiQ3Hr+ztC9vP9/vVK8Utu/KjpwqF+59mcKQUC96PqK/LreD35AEdXrz0/Uw+bN3q/vzd4HvKF6ffuJ3rB5c3ftN3cfMML8JeknmmHzBu7nvIH7gGXm7z/PLXM9P3fksz7Ua85tXJndMvc7RGPV0i/1RKU+G/7hBeDL3X8B6IQsaA==
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 role insights' (get-role-insights)"
---

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 role insights</h1>

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



This method returns detailed role insights for each 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"}>Query Parameters</h3></summary><div><ul><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={{"name":"sorters","in":"query","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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities**","example":"numberOfUpdates","required":false,"style":"form","explode":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"filters","in":"query","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**ownerName**: *sw*\n\n**description**: *sw*","required":false,"style":"form","explode":true,"example":"name sw \"John\"","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 roles with information about insights for each 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={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Insight id","example":"1467e61e-f284-439c-ba2d-c6cc11cf0941"}}></SchemaItem><SchemaItem collapsible={false} name={"numberOfUpdates"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of updates for this role","example":5}}></SchemaItem><SchemaItem collapsible={false} name={"createdDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date-time insights were last created for this role.","example":"2020-05-19T13:49:37.385Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>role</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A role

</div><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Role name","example":"Software Engineer"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Role id","example":"1467e61e-f284-439c-ba2d-c6cc11cf0941"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Role description","example":"Person who develops software"}}></SchemaItem><SchemaItem collapsible={false} name={"ownerName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Role owner name","example":"Bob"}}></SchemaItem><SchemaItem collapsible={false} name={"ownerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Role owner id","example":"1467e61e-f284-439c-ba2d-c6cc11cf0941"}}></SchemaItem></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"}>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    \"id\": \"1467e61e-f284-439c-ba2d-c6cc11cf0941\",\n    \"numberOfUpdates\": 5,\n    \"createdDate\": \"2020-05-19T13:49:37.385Z\",\n    \"role\": {\n      \"name\": \"Software Engineer\",\n      \"id\": \"1467e61e-f284-439c-ba2d-c6cc11cf0941\",\n      \"description\": \"Person who develops software\",\n      \"ownerName\": \"Bob\",\n      \"ownerId\": \"1467e61e-f284-439c-ba2d-c6cc11cf0941\"\n    },\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>