---
id: get-access-request-identity-metrics
sidebar_label: Return access request identity metrics
hide_title: true
hide_table_of_contents: true
api: eJztW9ly2zgW/RUU5yFLiVq9xH6ZUmxnSl1OO+Ol8uB2TUMkJKGbBNUA6UTj8r/PuQBIkZIcu+3U9FLKQyyRwN2XAwi4C3I+NcHhdTCMImEMOxe/FcLkbBQLlct8wT6KXMvIBDetIBYm0nKey0wFh8GVESyfScOGn0Ysz5gWeaEVk2qS6ZTTIMYdzdSRaAetIJsLbd+NYpCYityx9VxLpiXPVjDnmmO60CTjXaDwBfOkHwcirUCSMHOez4JVCT9yxadCvzKsnMBGxySFBjupBUTIdSFagYlmIuXB4V2QL+bEwIC/mgb3rUB85ek8oWf73f5u9G5vEEb9/W64M+Z74VgIHop4MojG3YPe7v4AMyohtdNJxGfjX0SUPyLreTm6NJrMRQrJXyBwPx7vdntjEU66k3G4E0W7Id872A0Hg53eYBDt9t8d9OoCW1LPkZEm/h4pwQMTTe1FZk1E/tYUIbkU9q2MN01uCjU6ZtkEgSjqQvl41FLcCvtOiyhLU6FiF5gIURK4ZqvoYPCu+26wNxjE/d2Dg27PftrrD0TUHezvkmWdHOvyLKmc/Hg5ujw9+Yi/a3ION5pMqCKl7GvOHB4dnVxc/OfT+dmH0ekJHpyf4c/NPQkhc8vKkRuB2rmYBPf3D4lxj7w1Iio0ot+mENJWH2UqF1/zYQEng7mM1aEzXuiDNuRzeOKWJ+ZQCx6D9Q2518wzZZxr+t0u/WnqeFGkKdeL0iGYkBU6qjzDVcyqJ7m8pYSEJ+zYGIET5Zgyz3RuSgokBHI3ZqlLZTJZRMKrnLhDykRG1qWdXwyJcLcedFVsPTnobK3At88ynzk712ZJcIckmObqnHu0t4MHqkgSPiYXuPhfCQAWZYXKH1INQbFig3zGczbjiGCekBcWDPVGsanminJwNeSlYtZ34NaI7XeIjVWdnPH/aK3KGPgCmSC9VciYLJKc9HOR0lBllxIgy3kyqvT5HjpcEkmGTBwLTYosrcW+zDJmZlxDslIlK64VtuoqPmtQDrxHGlL3uhDb/FbweHjLpZejknqcZYngytaLCS8SiD1B3q0LCcGZdFZeGhfVL+IKgYFEKlTcZh9o7kPjVJYvh9ZFJKtASCS8jMvocG3rhZLqTS2DATTUHG3tyZmB+RLBSvbsmOecjZSR0xnCBlmvIA6qhY8L1lR1MyOS3HJjGrK32QjOzV+V31v4AhvlqBiGOkYKnSTs4VmYFj4sBdMiEbdIvbKEwZ6vrDljwiepVOBN1awK6xrsWTV0OebCkkI5nshpYTvni6z9qO2k/eKZVbW3rMkrLnnQrGtRBgtS7D+FPYXgUoRNtlnBTZboSxNmc3SIr9Lkri1RjJTJ2X5KZGGCgJFQDlJpKEIY9IsRIvkmrdYa9wOA957+tYKdTc31KJEYzE60BqcQQJ3gNqRqisnGGRoFpJPKZvOLOmazMSLOYaGjLN6IgprCfkA6hOhUNiuEFTnCRN8fyFxppm3qgGTZPOy4Ji6DJdo99p7H1cLkyCtDJtU8+hW0Rk+AiVdKYj4rp6B2V+G/ga3YF3y81z3o70z2djjvv9vp7e+ODyZ8MOgeAB4S9xRuRHWtdyCuNV+ssf6XUALeZUkWwSP/hUHQzY1DoY7508GJpfEE+19CLze2UtPLywj5tVDW3h99Yjv7LOFqWtjnfLpiBBVeXaw1T2juCJ9pOZVqIyD2oPb45MPw6pQA7fnJv69OLvCJaK2tJIe0aowpLDPbf2fZFyuxV+ALN8wgsyJKLfbWU30Lhbgy9YHSfTMLQxnqqwNmeO4bZtRJs4nO0kYqRQ4ms9eyLdotlHrj2wUbc4MJmcMsbyml53l46i35ls2A1oR+02bDOJakJOAFshFEMZ9gHOMxgSQPeiYFUlnYopsVOZVIuQJ8aqZchTJlXTmtO4WSA5I/HieorgWEs2rWs7CKFi+i9w9kdpZrSndZM5o16ULl1OIwMlnAjNoiwDF0k64fUAaTuwwKjyrHVRWrXi5tufvohDnOM/su4oV5Qt59SlB+Qqta9eJW+OSzDd+jVfJG6SZfkfCS1LaTK0zrbVEmPptIkcTb3N3m7jZ3n5i7qy/P/ZaCf2uhT28d+lwpXsC+2jbPNeijhQOWrBzk9nicI1uEyzxE+uHzJRL7V6yhCb19nUuPQL8TPnKtfE34YeUP93xM8KNyVsMXJKC1o9+lQiUS8aGVeymxA4nWVIN1bh8yPZYIULUBIqJqarbICkbrWV0oZResWObEmTC0mPHLcotybQUkrioO5xkW0lskuUWS22607UZ/n260RZLb3N3m7l8zd7+JJCupbLZ4nGTcj1Mu0vx70pYzDGDlj1usSjnrqlW0QsRYhbGCJnIIxv3euDfZj8ROzHfivcHBpB/t9fnufm+/N97p7wf1Xn+9zOMqyZo5VfO386M1MUDcLXBcoRBcJs+yuLn9V9BPLRMqa1R6KtwMm8OkNxV27B+sY8fLLGMfuVqUCMk0MKRa2ohqGsamNFaXYzGAsynqomIoVRJyUSjJVICKRtCwRKbSJi9pAbp6EQ4nOVRxiVIGWcVFqigpIKGtBElGqDlDYEnadJ8Q5gMFi2CnqM7fEZ16F70IybNz0viUNGYnXyMhKNEr5L67aX93BOE11YgL5+AHNnrdaocrBAAWBK5mVbhzi8+3+Hzb47c9/u/R47f4fJu729z9a+bu78DnHg09jM8x4Mn4HGPbXVZhqQ/2gMD/G6bbVPES2PBmWRQV2m43lxjc4gqEkj8HSzWEzlweBp2Vo3jlKaPQnyfp3C2Pv953qtMJoTMMXq8dPL3vUHh17uj/+4DOAxLAdLoVOgHPWZ7PzWEHQ4SCq+/bfC7bJRuVfWlHWdoZw84bShidNXDpSgPsaWDHoG2dpCXlgSualrhzmT+5ERi4zm4vf5MynVClWFhkBcqkJdOiwz0+Ju1jiDjHguSVsaPbNgbX9INeVzq5f7kujtADumwy3ze5YTyDpCsqkgq145sXhN4d97VDnMuORCu+/hqzMxrWZ+8F11hauB9BXv/w+fINmxJmtTWjsMdY/KkWzj4hRGxNHJY/CNAk26Z0Vkzd+aBh4ycXykE2SaAw+0ldCMGuywMuP6JZnKO6W5PSJGELCs26eV16Jxa3IqE+2l5akgJPxqoDC3V4Y94b2zPt4qJ25rz9kwrZsT1yKKn30xivol0rsut5qRev6fVcIf5RUgt91lpq5s2KFM6015E7whOhEBAJnhhrrWczd/TCGr3Qng4NieqqDGQJL0fzh7Ko9Nqz5WjQC4leU46f1OeZRENuTmOu/jGDfprEbMSiWZYZ8U/GKHQoDa6nBbLo2WJ9IaahzYiw362JFDqWoQwBL618p0gM5YKJj6m9W3STAfip2KXkz9azyPmf7YGxnxs628fX6MI0Ms4i82yZiWFIDENXA4yX3zU5Ciw63wodbB1wAXC09L+tBF7QWt1ztDZWdUu+Y+dQa4ggqqVi5ofuy+GywPlPzL6g0dUYlGFC59VPh/jOPC3qdA1jlfsKqxZclzfJ0GBX7Obkrfa1qOn+2fQljYfL7ZczlSy+d5V+oJL8eeruH1TxtpXm71hpPF6mcLNs/cKiHuTvPV5b3w6019QE/sdbm6sWmmPhszzlXCc0T3hOUW2zOprZG0RazAXPCfu1KLKy1GYi1vyU/nRLgAhNNcYgbQ0wKR/LBPTsVnfJmduEccCS/ErfTWEhOvGKZliYijb7jLWdiuAWWtfRYQ28+yXzC7wLeOYTOZYdl84G6ErTQvm7NEXK6HrFIxERSxMVrnD5w9lOhcxCv2pWmcUUaqRC265wdGrOJrRHjeVvzfGP8ILfjd+g5u5Wgb91tlTkXCQ2MmlcE7Y/RhvRFs5EMqeVJaouAJiocfg4ulyjCGLKXyTI9LTjJ5kOjaWLEFDehc+g3Wt3Q7tcwPN5ZnKshWvE3e58iSXL5XV1MyStbjI2ovJuuVP/vHuUvo/QAqAzp90vkq5wCxK3jrwOHllHgsph4yLl2lKSRmy6xegvCh7av1igzGAVYnh3RzsutL66p8eYSMv565vl0skuOeE1+hxvPrdfN83rc3+j8A178C7nRkuUu4VqsdwoCPDxV0H7CzWtaYn4LHm+fV/zGUKtG/q7y1ZeOnyGdPbt/Q3GuV0z60j3yu2r1Sat/fJEi9hqr+NfJ5SN/AE85D8gaFDx/welJD0v
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 'Return access request identity metrics' (get-access-request-identity-metrics)"
---

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"}>Return access request identity metrics</h1>

<MethodEndpoint method={"get"} path={"/access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}"}></MethodEndpoint>



Use this API to return information access metrics.

## 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={{"name":"identityId","in":"path","description":"Manager's identity ID.","required":true,"schema":{"type":"string"},"example":"7025c863-c270-4ba6-beea-edf3cb091573"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"requestedObjectId","in":"path","description":"Requested access item's ID.","required":true,"schema":{"type":"string"},"example":"2db501be-f0fb-4cc5-a695-334133c52891"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"type","in":"path","description":"Requested access item's type.","required":true,"schema":{"type":"string","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the access item to retrieve the recommendation for.","example":"2c938083633d259901633d2623ec0375"},"type":{"type":"string","example":"ENTITLEMENT","description":"Access item's type.","enum":["ENTITLEMENT","ACCESS_PROFILE","ROLE"]}},"title":"AccessItemRef"}},"example":"ENTITLEMENT"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Summary of the resource access and source activity for the direct reports of the provided manager.

</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={"identitiesWithAccess"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","nullable":true,"description":"A count of the provided manager's direct reports that have already been granted the access item in question.","example":8}}></SchemaItem><SchemaItem collapsible={false} name={"identitiesWithActivity"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","nullable":true,"description":"A count of the provided manager's direct reports that have activity within the associated source.","example":5}}></SchemaItem><SchemaItem collapsible={false} name={"totalIdentities"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","nullable":true,"description":"Total number of identities who share a manager with the identity requesting access.","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"squadAvailable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if the manager's ID can be found. False if the manager's ID cannot be found.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"validActivityObject"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if the requested access item is associated with a single Activity Data Insights connector source.  False if the requested access item type is a role. If it's a role, it matches to multiple sources, so a single relevant source can't be determined for activity metrics.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"activitySourceConfigured"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if the Activity Data Insights connector is configured for the source associated with the requested access item. False if the matching Activity Data Insights connector is not configured.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"requestedObjectActive"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if the requested access item exists and is available. False if the requested access item is either missing or deleted.","example":true}}></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={"{}"} 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={"429"} value={"429"}><div>

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

</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={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"message\": \" Rate Limit Exceeded \"\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>