developer.sailpoint.com/docs/api/v3/get-identity-decision-summary.api.mdx

---
id: get-identity-decision-summary
sidebar_label: Summary of Certification Decisions
hide_title: true
hide_table_of_contents: true
api: eJztXFtTG7kS/isq78MmFLbBGAi8nHKApNjKheVy8gDUiTwj20rG0kTSAF6K/366W5rxjG1iLqndTWpeEpiRWp/6pq+bmblt6FQY7qRWh3FjtzEU7jAWykk32ReRtHD9JBuPuZk0VhuOD21j97yxJ4yTAxnRNObvS2Ebl6uNWNjIyBRvgLTTkbSsd3TIjHCZUZZxZr00pgfMjQSLwyKWjXksGIjjismAgEV8nHI5VCwqr9hip5WZ3IggVv4lYtafMDdJRYv1mNNfhWLX0o3Yx+O3/+vtvz/8wLRhewfHp+E3nrmRNrgYQDXiWyYNyHAa1k4SgOg30GLH4kqKa2EsG4AAul4BBeMBe2JnJ4LaUm74WDiYC8q7bUjUTMrdCG4puAG/yRh+ttFIjHlj97aB8OGqdUaqYeNutZHjauw6k4l5LYsZLIf7IE/cgPYSFCQGG68GO92N7rbY6W5udfqb/f6rbqfLN7c2drbjV7BEgPUtE2TpgGsgE4JdRjCATYrvop0unBsyuFBLxkx8YxdLAV00GrObfENQwEI2S5xlmYXFyIOs4yrmJmZ2ohy/YX5aH4woFTv/7wb530k+aE8niYhISUeFWS5fjJxL7W67HYsrkWBEtCyXSaqlcq1Ij9syVm2eyna+WDMq5DSn5v3N6wuQNQPOlxfqQr3Jr6KL2SxNtXEAz/uRgP+TRF/j7YEUSQz+rGLmo1Ibu4sSVlbmNbmysstWxLdV2OZK4+4STWRTCAeIQzBKZ20N/6vq8OR7sQcaj7RysAxO5GmaBG9qf7E4+3be5Lr/BXSAHm4Qr5N+bUKaiDH8n+cQ+x5XmM4EvYqhMHNW/pCN+2BlAFgSUgLqRtyxEb8SrC8gsgPuwuE2Vhug1TF3fomNDrojjyJh7ZHRYB3xdEBeDEu9nIdj2lyEyejnQMHZDwfQuUcpOnuOfYKAh8PoLoKxyFVOtePJA7Bg2nM4lqklXgPB7mZz5CrrazgWILgBnRMUdFLlv5aBbz3cqZ4D/V7/eh769bWl/vcc1DOu+DysC11k1lOfqeMZp30e4FdLfNr2UrDnFR6bD8K7zJEXhBi7HsloxICZANB8tWXRX4YIxAZY0t+E0ITFyg66NLyersXH5Oxlilx+tjxZlU+FuUCbC82NQfp0JS4/bZ7kgwTqqRp7HKYFelqYFUN6eJa/LT8Ul2nrvoAgaM9wscchW6CzBREAyCgLwJW8bMTicLZ0vLvDkd1FnHQvkZhBDowBOtyEMgsLRSTvnqNi3SGsg4wcU4Um1RVPZNz6cWw1Fg6o/p6u8J9QzMwXIUo0h4ZLRCgIcgQTMXKvZIwUfqwNOiaKzGk2jWtVCjLQRGudveYx7Nfvby9sBhVqePQVZB3GywGdKQnzWT4FKueirFiwrNgWvL+1ttPpDra6nHdedde3N/s7A76xsbazubODq48hE/GhV01YmxvDJ3NLvxUKipqIJRoKXiq8jeCgewJAi8MU6cTYLrcByXiA/tGn/dhimwEvc+LGrTLOXu8dse42S7gaZnSdD2eUoJpnJ1jiZknC+3gJa2rYuRf80cihVIugCIgm7H7sH7zpnb07hSvHB3+eHZzATyhrrvnRU+CtMbqlphAc6WtCHDZwzaEYFFhEirjFVoLUFdgQp+gsBkr/m51YUCb41oBDZQkzwuoLZpRFs4HR40ooUdzcOPZCtkQLuA5eg6CGwO9zCxMCJVrpwamUuua7oMkVNhKQI8zLFuvFscRNAreCaAShMH8CghiPY193U12bQSgL6r7ozDGlnYxE1RZTVVatMc0q78pGweAA5Mv9pBe5DMDRNstRWHhLgBjsA5i95qroTktKI5VigwFqfmzwTECNxoCGWR/2Jp1lIR1RjQ+JR+XjioxVTpaU7t57MPtO072IZ/YBcXeUQPpp0taKG1ciBJ/FzpXPRmSN3EwhI8FN3DZNDqMKc+WB77sQdezWsVvH7gNjd/bmcejEhbtEfdbnqc+ZCs1nPDznqI8h71E671D/5Vu73pCr2MUOFOmPT6eh0Q3jxU2KbdofyI/8UT4HvlfYIzRc835sfvRPbYEASY9+BwPIRCLeJdxTxKQor6qN+dXeaNOX4KBqAUWErGnYRGf0dwCTKYVIuF1lsRZW/R5IbqixKAPiqipu+vZuzSRrJlmfRvVp9MucRjWTrGO3jt2fM3a/yyQLVBQtgSeF5ym8p4X71PBjMIDlfxNmRciRqWbZCgpjBcdqVJlDo99Z768PtiPRjXk33trYGXSirQ7f3F7fXu93O9uN8ll/Po3jIsiqMVWyt7cjqRhI3BXwuEyBc1mndVxt/4F6jRhgWsPUU/Bm0Dmo9HLKHbvz3PGDdrA3EAzc0dzTXjw7fofy8fEOFI9605mJBNJsrzrfL0VKiT4MmpbW1dSxpo718VMfP7/M8VNTxzp269j9OWP3UdSxu4w6dh9BHbsMKdYAKdY/SR1j4B1IzQZgFNhDlIF6FdLGFLYCP4XuYwh7x81QuILoVVhkZ2eeRZ5qzd5zNcnJkq10ItVUXZjeYOwYx5p8LAzgbAgpUjHIWhLYLXqVHAvkpOA/LJFjSXGMGwK5ZtLsDfCBVx8zub8Vq0gVJRkgpKSQaOy9avAxCe4kBkj/QAL1QYeQqH9gjzNY61n9YHaMO36HO2YHN5EQGPNF/3dz0VMChwDeYLo48ba+53EB3zPnCsoIcZP69FVQ0Jqq11S9Pu7r4/7XOO5rql7Hbh27P2fsPoKqBzZ0P1WHAQ+m6jC2tcYKLvUGnetvZ+wUKgEBuTfTEXH1eMrBiVeAK4U3EjGH4Ptyu4125UF9276V8V07f6a1aYs3FX1J4BFmJoGZ+Rtet2A4MNhdi6eylb9VpfQ1veZ1tbEgDeFTpz7kIJHFmX95DF8q84u0SN1Gokf79EcLeOXTBtF387fJvisf37pDq06gJGFezCq+yxi8iy7jawhQWvxuaXSLvGluj7C3M5PcLdtPeDnunn14IffsY5H6vrsWjGeAcmZ7CP8SzQUeAILIXmeAZ8/nrV6GVj+/LI85QZ7uEc6NnJ49+BeCzhygjzisw14LbqCI8A/NvPjj0+lLNkR2StnBv1koJJYTEF9H4EaU/Xr5AyQ4iQ4ko7PhiDbXqzyig9HGBgkohV2oEyHYef5s9Ac4Fo4hj5PacZKg1IGzHv4OIq/Me0mnI5URUvnHs+Fq60I12b40/hVF/85q2CJVhew8zffFS/t6KojfcmlNL61J0vDtxwoKr9rzyD/yHUHIowieWNLWkxf38poleVhzwRWUOosBNRFwVB+sinKrPRlHRV4T5VVxXKhP9Hx9dRrzmY5ZODmTmB2yaKS1Ff9hDF0HQ+V8mEGkPRkWPdTfpIhodtZKkJp+yaZsApEkfO8gMJR3Jt7Hg5x4jPYtFQrbz2RZyAuf6bWoz5U90+VzOG9xZKyjR7xYO4MZF2zigk2fJ2zA748zdCyIbdwD5QHvAHtT+1MmCEBLedHLWpj5SXyb5uDxEQFUkmLTXf/L7jQJhp8Y3cDRxRhI08jDi0fN8E3wIAvPtIqy8g7CrAbn8SYajtIZvXm8xd9B8Xj9t+0Xd9ybNlo+qmTyo7P0PZnk35N3/6GMV2eaXzHTBGaM7kbLzrx4hU7uGd182w/70iMB/8JdilSi4FDg+I9jIIcpi0kT7tCnKaajkRTUMEgFd8gOV9Gv9JjiECgxBj+UhSRoaGAMBK0Fxsr7MgF5LfYJKjIVgYqxGsMHdUHqFx3KshPQ8hEaie3nhgMCNR5nCr/JASCyMcMX1ZZYN5Y2ynwSguJMiXxnmmhcMSuPSHQbVEWL6hIzth8H2FmGorVkxCVrgQ1taCuDItEi4asZ040ci8QXKjCuStGXyQbPaY5EkmI9CBkUyJQorfD+8HROIghT4W8Z2gzbYZJt41gQguWQd4aNFlSBeCnV1kHxWpJb+kBE9RsvxdvXs651O22r1197oa+9hLMNi5J2ir03VHXmCylfxZ43qlUsTNqlL8DMFbJQ9ozASDjl9hY7NljV3eFl/6EWLJfAYzAop19mudc+9SdUvvcJlXss91Vg12X6IZzQWWnQJ1fyevmRhnhxHDzvJfn2gm/3LISSt3nVpIwjhwgedHcJo3znjhD5G763V5oy99cv3ErRb3l7APni7v/9RPkO
sidebar_class_name: "get api-method"
info_path: docs/api/v3/identitynow-v-3-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 'Summary of Certification Decisions' (get-identity-decision-summary)"
---

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 TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Summary of Certification Decisions</h1>

<MethodEndpoint method={"get"} path={"/certifications/{id}/decision-summary"}></MethodEndpoint>



This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.

## 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":"id","schema":{"type":"string"},"required":true,"description":"The certification ID","example":"ef38f94347e94562b5bb8424a56397d8"}}></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":"filters","required":false,"schema":{"type":"string"},"example":"identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"","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**identitySummary.id**: *eq, in*"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Summary of the decisions made

</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={"entitlementDecisionsMade"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of entitlement decisions that have been made","example":3,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"accessProfileDecisionsMade"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of access profile decisions that have been made","example":5,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"roleDecisionsMade"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of role decisions that have been made","example":2,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"accountDecisionsMade"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of account decisions that have been made","example":4,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementDecisionsTotal"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The total number of entitlement decisions on the certification, both complete and incomplete","example":6,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"accessProfileDecisionsTotal"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The total number of access profile decisions on the certification, both complete and incomplete","example":10,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"roleDecisionsTotal"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The total number of role decisions on the certification, both complete and incomplete","example":4,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"accountDecisionsTotal"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The total number of account decisions on the certification, both complete and incomplete","example":8,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementsApproved"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of entitlement decisions that have been made which were approved","example":2,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementsRevoked"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of entitlement decisions that have been made which were revoked","example":1,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"accessProfilesApproved"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of access profile decisions that have been made which were approved","example":3,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"accessProfilesRevoked"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of access profile decisions that have been made which were revoked","example":2,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"rolesApproved"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of role decisions that have been made which were approved","example":2,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"rolesRevoked"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of role decisions that have been made which were revoked","example":0,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"accountsApproved"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of account decisions that have been made which were approved","example":1,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"accountsRevoked"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of account decisions that have been made which were revoked","example":3,"format":"int32"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"entitlementDecisionsMade\": 3,\n  \"accessProfileDecisionsMade\": 5,\n  \"roleDecisionsMade\": 2,\n  \"accountDecisionsMade\": 4,\n  \"entitlementDecisionsTotal\": 6,\n  \"accessProfileDecisionsTotal\": 10,\n  \"roleDecisionsTotal\": 4,\n  \"accountDecisionsTotal\": 8,\n  \"entitlementsApproved\": 2,\n  \"entitlementsRevoked\": 1,\n  \"accessProfilesApproved\": 3,\n  \"accessProfilesRevoked\": 2,\n  \"rolesApproved\": 2,\n  \"rolesRevoked\": 0,\n  \"accountsApproved\": 1,\n  \"accountsRevoked\": 3\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"}><p> An example of a 403 response object</p><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={"404"} value={"404"}><div>

Not Found - returned if the request URL refers to a resource or object that does not exist

</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={"404"} value={"404"}><p> An example of a 404 response object</p><ResponseSamples responseExample={"{\n  \"detailCode\": \"404 Not found\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The server did not find a current representation for the target resource.\"\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"}><p> An example of a 500 response object</p><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>