mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 04:19:42 +00:00
85 lines
30 KiB
Plaintext
85 lines
30 KiB
Plaintext
---
|
|
id: add-access-request-recommendations-requested-item
|
|
sidebar_label: Notification of Requested Access Request Recommendations
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW2tz27gV/SsY9sMmGVEvy88vHcV2Otpx1q4fk5k6ngYiIQkJBWoJ0o7q8X/vuRckRUryY7Npu5sqmbFN8uLivnEuCN578UwlMtWxGYTegSfDsB8Eytpz9WumbHqugng6VSZkkuKuCgepmnoNL5Vj6x1ce4P+QLhxIicRSyO9m4YXKhskekbXmOpyoq3onw1EgMfZVFkhhYlTPdIBDxHpRKa4lxSMVCikmyPJ59CQQtzJ8oYKm6JkG8ZgCYYYlGYyiuZiKr8ocFUFeQMMBKg/ZzZdmjznc6ejSExUNBOzJL7VoRIjpcKhDL4IbUSchCoRaSz0lB4rEWfJQlyndxNWyqd7G4dz7+B+xQxqnYqsGlugpp8YxYmQRkAUk+p0XrDXiYL70iRTDQ/2TPGUppKzWZRr1Ppsab57zwYTNZX0VzqfKUgQDz+rIAUjKIFgSLWy9LSYguKipLVpos0YtJBjKjGHd3U1OPJWfatKEcXgSKTyC4ax7eENsi+GqK9yOouIazfY7+y197Z321udrU6n3e7stnvtYXtntNXrqWDfe2h4zi4vEfu3iwsJ41HN8kNF8lb8slbgre2wq7Y7O3vtzna41R3t7bcD2dne65DAToRVUZTJppQz/cPD44uLf56dn74bnBzjwfkpfq1JE8QsWCxJWJdnhRcM7x48nsyUwpck28PDi+mZdhFv19UgKV108yJ2/aBgepTG4Os42xlyxjmy2+6sZssv1QJhM2Y/yii5kZMmvotUOHbO2mTBJgv+Y1lApFixUsz8pJ0xRvlEWrcbPOu3d/1O57Kzd9DbPtjabbb39/7xUhkWqXOeJ8wihXrt9mrWHEYaUSiOkwSrh4+lOc0Sg8VEj6rLoRhigaL1UJtbGenvmUWhSqWODuNwbSzUhX2njfLHidQkoWKRAwzMV2AKyGmcKOFYUjyQCkxXjwZYotkRb2VYQpLDXBmycoJ6AV7r07ou0JXRGC+KIUhpXoUfmVbtKjncae93e6OdnpTdvV5nd3u4P5JbW+397X3OYoSOlWNVzWOZJHK+MvXflFGJDkQUB/DIv2CQREnYngXgyTGEEuEFJYF5vMD+lGqOtlQzl1ek6itAkxRvD89Eb1dE0owzvi/HS0Yw/tUF7hiUZjmkWwRNoLljfJrosTZPlYWj43f9q5NLqgfHf786vsBfxGulLvQBhUxIYQlREQuT+I4lzhUg7GRVBHMQNHyTc30DhaSxVULtruzcUt0L1UhmUYoR+exrRlRZi1EST2upxHnzNRWvdFM1GyikuIeSEEzEUFoMYHirxBvK8lnqn+SWfAOwKQEqXzdFPww1KSkjgWwEU4yfg5EARKfUdQxGGVIZwuh0EmcpQ9hA1X2xMGXdG4tSc1J1CiUHJH8+TvoMqzkmallYRksuYu4fyOwsV5fusmI0NuncpLQ4BozYgzjB6oPKlBHYtyIvR+Qui8JjCrqyYlUrKJe7904YVyBRz2RmX5B3ZxHKj8+qlQ9uVZ58liB/0Q/IhZvyioSHpDYPzqlKdxWJL0ZaReEmdze5u8ndF+bu8sN10GdNw3BlZAb7Jrx4rkCfhKPHxKIgco2Fc2QDDX4BkX7+cInE/qIM0auvM+p/viM+ckv5ivD90h/u/rBoH4qlf+ELEpDt6DQYoRKp8IDlXkjMhnKm2lqd7V2cDDUC1KyBiKiaiZjHmZAwWZIZQ5JI2+BdFvNTKibyVhXInCsgzWpCfxZrk26Q5AZJblajzWr046xGGyS5yd1N7v45c/dJJFlKxdmS4ySbTacymbtIy5/zTqQAgSh2rUWZcuyqZbRCzESJsbw6cvCG3c6wM9oNVC+UvXBna3/UDXa6cnu3s9sZ9rq7XnWtv17kcZlk9Zyq+Nv5kU0MEHcLHJcZBJdN4zisb//BvIkaUVmj0lPiZtgcJr0psWN3f81brDgW76WZFwjJ1jCkWdiIahpop0SbFLQgkGKMumgESpWGXBRKeqrAJUHQiEhPdf52TxHfZO73RylUcYlSBFk5izZBlEFCrgRRTKg5RmBpKKlGhPnAgRHsGNX5O6LT3EW/C8mLc9L4hDQWx18DpSjRS+S+vW5/dwDhE6oRF87Bj2z0um5HGgQAGgJXs0rcucHnG3y+WeM3a/yPscZv8Pkmdze5++fM3d+Az3M09Dg+B8GL8Tlom21RYql3FFz/dZjOqZJLwOEt4iDIEt5uLjA44wqEEgk0iy0XEZlOcNWS2nebsH7uLn/pPFqrPErmu4rU8FxX4OTNkghsJmk6swet1j3cCPc9NOVMN4uTLCa+a4JlawjbrSlLdH7ApSAR8Ek8N0GTDZ9oim1XCJm5cwOrSlEMd/CW8ZOcjZyyf+d04M6xadDxkDzO+DZEnKHJ+MkydZPjakU/6HWVRA+/XxfH6BFd1pnvydlALyDpkoqkwg25C/EARuyvK8hz6KpYP6MQuL6p0lwQancSrlAuViLq9LorAp0SWVe8VTLhU4708uPVzx8uX4sxYVWuFZklmKw0NRfItjOEEdfCfvEigAbx8pTE2XjCyvVrr1oo98QoglHER3OhlLge5Ib6BYvEOao6m50GKS4kNOrmVeHBUN2qiNbP5sLaFJw6NC1YsSVr417zWslNhTbukA6dwvpofHGkqYRRhjBNriL3iOJ6VuglK3p9qxB/KbgVmcrc7OslKZxprwN3dCdAASAWMrJsrW+e3PHzK/yoA8Md4rosA1kil6P+giwovPbNctT4+cSvLsdH82GisRDXhwlX94TFOhqFYiCCSRxb9VchKHQoVa7HGTLtm8W6o0l9zgi/266I5Lspfe0DVrJ8J0gM44JJDmlZZ1QTA/CZ0KXtJ/Ys6sInNN2h+FTTmW9f0yliUIZxYL9ZZprQpwl9VydsLr9b3Ciw6EgadOA64ALgcOF/rgS5oJXa6HitrfzMvsVjaPkIICpzsbMDd3GwKIL5X4IfEHVJg1JNqLx8ZYhrkfOiFa5mrGI/YdmCq/JGMRbWJbs5ecv9LFps/2j6ksb9xbbLqYnm37tKP1JJ/jh1939U8TaV5kesNDlOpu3L88XnF8dFR1M/2P380evqyWtdGfH42efi6PPyqWSSipKAjZG3OdXUe5sjzdXNScsfr+AnnnIF4UYBbRg3loytqoxmkUwp17jWBBOteFtjpmRKqLVB8R5PuT7Mkph0U9YxGiegQTGxQNNyqCP6zIQ23ouZJaexg8QUbXRtM+6taK5ggjZZNcUHdJomQLBQl0lHR/Dsc5y3mxeIlzMKN3FUhCCg4HSaGTorD7GzqZAI9GfiNNQ2yFw5RdNpVGGLmAFpOaqoLZQApEKT+61kak9HtGOOZrwSjs/MhWi0+XY5TE9epP6CWrlSkXMV5R89NZYajud4Iwd8+tyI+lysBYCFqjLD+8HlCkcwMxZ6BaoZJ+NWPsi2iBZMqLFz4bPV7DTbPjc6uE9tIzrzCvPalxVoPMpPvZ77sGspTu8XbxL+jz7xynOduqvWjLYUyciZ6whdb37tPdube+WnYmV3jl5uQh0+ht/f06YUtasPdBt0tONxfbPoRLn7wwDenOL28IuiTZH8bYjP3zmUux+rr3moQXYj3IbXk7Q3lU2Is1Pa+vOG+QduU7efksg70gg/D7yP+I+LeOYUBRHfv/eK3UnQOL7079/RCMJ8
|
|
sidebar_class_name: "post 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 'Notification of Requested Access Request Recommendations' (add-access-request-recommendations-requested-item)"
|
|
---
|
|
|
|
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"}>Notification of Requested Access Request Recommendations</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/ai-access-request-recommendations/requested-items"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations.
|
|
|
|
## Request
|
|
|
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
|
|
|
The recommended access item that was requested for an identity.
|
|
|
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"identityId"} required={true} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>access</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"AccessRequestRecommendationItemType"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`]"} schema={{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE","title":"AccessRequestRecommendationItemType"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"201"} value={"201"}><div>
|
|
|
|
Notification successfully acknowledged.
|
|
|
|
</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={"identityId"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>access</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"AccessRequestRecommendationItemType"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`]"} schema={{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE","title":"AccessRequestRecommendationItemType"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"identityId\": \"2c91808570313110017040b06f344ec9\",\n \"access\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"timestamp\": \"2017-07-11T18:45:37.098Z\"\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={"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> |