mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
98 lines
30 KiB
Plaintext
98 lines
30 KiB
Plaintext
---
|
|
id: close-access-request
|
|
sidebar_label: Close Access Request
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW1lz2zgS/iso7oOTlC4rTrz2y5ZjJ1OeyuH1sXmwXRuIhCRMKIBLkHYUl//7ft0AKerwMU5qd2ZKk6qxTQKNPr/uBoGbyGYql4W25jCJdqM4tU7txbFy7lj9p1SuiFpRIUcu2j2P/HMRXrjoshUlysW5zmg+Zp+OtRPKJJnVphBMywnpZ+VhlijGshAyV8IVZfxVaCOkyDBJmxEeyUJ1xCEmSyMGSpROJZiR23I0tiXmVXQ2nEj1UMXTOFVCXSlQGRYqx1glZJbl9kqmnlxLlCbVXxW/Ot+XJlapmBel5vny2bgoMrfb7SagmZJuOk7qlF92Yjvp6sR0Zaa7Vy+7MZNqe/naga/u847YE4X9Co6udTEWn45/+ffewYfDj0KWxdjmupgK7dWhc5V0LsyFObViqE1Sq2FRZUyI2D87bAkjr/QIcmERcaJkHo+FxFxoCkNAGXPy6S7LXrpdcRRo7n08EBcLJryIOuLMec3s27ScGLE/trBaTsSdSlVciI3TXMZficTHcjJQ+UarsZ4SGwf22qRWJhtiUBaFNTRVfctsTtbaP/mXiK0ppDZEgSYUFTnD5Nzv08DeEVRQrX3+XsN4kMmWhn4W+koXWrmn2TMFMbImEcPPihgsShwemgz+R6seHjgxzO1EKDAFVTlb5rGqxGDxeJy3gLDDWUhU8jzaikZO1O5FtE+hJA4TZQrynyoCyX5h8rVOU8RSnJaJEndOECeFzAuVXETwxkSTYsdw1FrNFJawVKHBWcIM3U1q306yVD1ALK4GdcTpuP4TaOGneLZJ8awxXS0SaLCqGS/gHNqNwRPgQuW5zb26SVPwCChdj0bwJe8VR4h+7bAIeVLNJqNEUQ19nGckNnZdnteulujWv2SNZdq1oN3nYmhzoSRZdM6LvSTgmIGRIh/YGt69sck02r2JKliIdou8VK2IYger0yugWqpjhurub47w9iZy8VhNJP1WTDMFBLaD3xCz0SIwVzg3wDIik1OKV2aTWVmKtspfO4FBz9F5JJuJ4TDhDAAtQHcUKMzk4ogZazLP5XSJswUg5tiyHsZnGcNSKghaY+jO8HSz/arXW/JLpgCGqtkkgi7UpMmJgwnNKLptReqbJLORbP14pyeTvtzuyVhtJ696m/TbsN+P5U6vt9mLLjF+Al7lSC3TWla4hIlqFVfYN6/ojjjQLkvlFM5ZmgRMf5Y5eZMjN68k+2ivO0x/KMu04Cyrmi/FXjKh6ADwFFhuIk0p03Qa9OXRpKGMWuQfosO6U3FJ4p4wzq3SiQLEk25PVQ7ShCl4WAfkqvpBNfJ7M74CmDY1JhnNRup+XTVXbog+e3xLQVah0sOinJRsQjw5NFXM4493gI4yVw+JZK9QbKXpndJQvrhPnGqZpizVs1tIgkn8bH+5jGt6+6o4fUwErDD6vIaXNdlguQ6eH/O8WxI0Vy6zxnnQ6ff69GMZWDKC/TagoShzQ8lj2AQWcQ2lO2/PYUkLymoOsM/6HD51AI9O9GQk9uxu9XrLHO6nmhLSW0pn93DJmK3JL1DS6uQHeFkE60ShLkv3bfIIQHunjWqPctRxlEmZ5RgTfZByyTaxyPeeJNU8JILP1HPeCk10NsUbpJ8KsPeDMOS+oTSkVuQhhs6MxvxZNamTOnGsWFZtKzl43dvpbw1fb0nZ//vW5varwc5QvnzZ23m1sxPNwP3hnPWLMirXsUhtDIt8h0LyGdzz4iuSzh02YBqP0D+FjB9bixn4FYX6VqAmF2/2j8TWtkilGZX8XI4WlGDaZyd4YuDsckCPqMiA5J7wJxQ22twHfgdv3+2dvT/Fk+O3/zx7e4LfiNYS6O0ZeGtCbglW4QtjxHgxE4DjjpsLyucvAtUXEEga1xyoXSMIRYBBzAirr5jRJO2L9GYocdx8K8Qz3VGdFooKPJvIApXaQBLSUPOC4S88drTfB02+EGMlkZ6ptUtQtUJINJeIRhDF/ClVJzJJfHVKBIYlQllx00JNq7GFRoMwZ4uZKuetMcPw902jUHCA84f9BE0QwJN9Yi4Ka28JLAb7gGevueXSYA4lp2jh0BHFHpdtnlNniH5PUNkf4IjM5QA8phpXI1YzNTHcffDMHBSW38WydI+Iu6MU8NNm0eoXVyoEH5eJHo3YGpWZAiIFPOfJYVRtrirw0WWoNFnH7jp217H7yNhdfHkc6rLwlkufzeXS58yEzbDvqwq0nL3H2GrH7DuXN8GQLQGFhBLp18+nYauN9h2/Zbyh9vPqI5/KlyvL2h7++aDq7qrUP7MFMch69BIMgUQq2WW+ZxyzoryqXi6v9s7mAw0HNStKxJJ26qa25K2WvDTcKUnXEolVzmwUYiyv6qaTEdDvz7br7n5dSa4ryXU2Wmejv0Y2WleS69hdx+6fM3bvrSRrrjhaQp3kyslE5lPvaeE9SSsFBohqh1DUIcemWqxWiJioa6xovnKIBv3NweZwO1ZbidxKXr/cGfbj1335antze3Ow1d+Omrn+fBbHdZDNx1TD3t6OrGIUcVeo4/gLgCusTea3/0r6bDgkWCPoqetm6Bwqvaxrx/7Ocu14aq34IE3jo12zhjQzHRGmYeyExtafXfjL/EjTt3VAlQZf5Ep6okAlp0+XqZ7o+tMe6ObT9h5/hPeBUjlZvUr4POkYCVJLVbOFY2kIqYZU84ECV7AjoPNPrE4bX22eXMmLY5L4PUks3n6LlaJAryv3V6v2dw/BfE4YceINfMdGr+92pIEDoCHwmFXXnev6fF2fr3P8Osf/NXL8uj5fx+46dv+csfs76vNQDd1dn9PBncfW5xjb6Ym6lnrHJyH+12U6h0rggN1b2Dguc95urmpwrivgSsRQZvngbCaLMf7qzh8RdV0+2ID3vvL3PJV5iqHVobQbmAomuu3ITHeqY3HGXvPJtAH0swJ66IyADzMawOfi/AIdVm6uyX892DFxr+rqaEl9+O1eynQekWw4tSXgjcm0BHw9+BI/pkMgaCQ2HI/mExutJfkg11me3v64LJ7QHbKsUt+9q2G8AKcLIpIIl2Qu2ByE2F5n4GffI9VeSWY+v2yOOaHK3HO4NHKWbaib6y8x9ImG9cUbJXM+iUsfOJ79+vn0uRhRPcp4UPKZsnACVYojuBHj3V612U+TOAXx2Wl/dnbucwrFlximUIq4MCdKifPmkZxjIDernSYpBgua9fgDtXJunj8UyY2DNvh1wk87F6YtDjTBlKa8TmOCiNwHivOskks25HoqE3+rqFVntpmae77AhVfteeyP58QIciIhU8faevLinl67QY+6LDwhqos8kCYCH/MfweLKak/mY45em+jN83FhPo81HV6dmyY8tgmHXJkm4lDEfFD8H0KQ61ConI9KRNqT2bqmRdscEe1+r8FS2y/Z1m2UjszfewSG8c4kB5S6uXIJJ8g5bL+wZYELX/gQ85c5mfnxOTIsjaQTvk/mmRZs04JtjxMu8O8TGDkWYptkYBzwDrA/sz8jQWC0gY2e1krkZ/JdnkPpIwarTMVlu/6P3RkIht8Ev6DR9RhANVXe9WdBPpHoaVEWm1NWtWewqMFlflOL5LmgN89vvWdFCfWPJi9JvDfbWvlk0unPRuk7kOSPg7v/J8RbI81fEWlCLUxblMezyw1vf/zs8c85P/wjZ5ghFkURazP0Qk023oRSdXkH099Xcnx9iSGIuwn0arOLTU1CWSoLClYGq3isFe99ZEoWVPa2KGDshAEmyy0pU4UbUqMcY+hKEspxOdAp6PHufLWyv9/ja2pyV76GV3IDRmvFY/TSqiM+ox01MbyNWlE6X4J3v9nQk55AGUd8m+mg8mG6ZDMpDV3DANvlREhEygOOnmgXlx6P0ZkaVenCckVbz6rAiSKIROhwU5ZP3KchbaujY2/48wNrwZ1d2FOH6smK1KBQv1cLcqxSDjgaN9+xPEQbQdQeqzQjJ0EyQV2pGit8ODxdoghiJtwds/moGya5Lo0FEeoMvfu87Gx2em3ulPCceku4eIO4v6E1f5Nm0QdvZp8S1tc019c019c019c019c0H39NM7QCtIfTzejjBCFx6fed/C5fdTuy3uWjTMP7fChdxrQfiCE3N7SFTRtft/SYvYd2jmZ7WryPhAm8lc0bTV8VbaGGb6ft0yk3N2GvdPmjMG21+Rl+e/zesZeNLcujT/ShIBqEi6gTv/uay2s8pP/vRhf4hz9s5hMk3Val5zdR9S0DYzxd+u+/0Ai7Vw==
|
|
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 'Close Access Request' (close-access-request)"
|
|
---
|
|
|
|
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"}>Close Access Request</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/access-requests/close"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). A token with ORG_ADMIN authority is required.
|
|
|
|
To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select 'Tracking Number', and use the 'Download' button to export a CSV containing the tracking numbers.
|
|
|
|
To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/).
|
|
|
|
Input the IDs from either source.
|
|
|
|
To track the status of endpoint requests, navigate to Search and use this query: name:"Close Identity Requests". Search will include "Close Identity Requests Started" audits when requests are initiated and "Close Identity Requests Completed" audits when requests are completed. The completion audit will list the identity request IDs that finished in error.
|
|
|
|
This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/provisioning-completed/) for each access request that is closed.
|
|
|
|
|
|
## 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><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"accessRequestIds"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Access Request IDs for the requests to be closed. Accepts 1-500 Identity Request IDs per request.","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reason for closing the access request. Displayed under Warnings in IdentityNow.","default":"The IdentityNow Administrator manually closed this request.","example":"The IdentityNow Administrator manually closed this request."}}></SchemaItem><SchemaItem collapsible={false} name={"executionStatus"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`Terminated`, `Completed`]"} schema={{"type":"string","enum":["Terminated","Completed"],"description":"The request's provisioning status. Displayed as Stage in IdentityNow.","default":"Terminated","example":"Terminated"}}></SchemaItem><SchemaItem collapsible={false} name={"completionStatus"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`Success`, `Incomplete`, `Failure`]"} schema={{"type":"string","enum":["Success","Incomplete","Failure"],"description":"The request's overall status. Displayed as Status in IdentityNow.","default":"Failure","example":"Failure"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"202"} value={"202"}><div>
|
|
|
|
Accepted - Returned if the request was successfully accepted into the system.
|
|
|
|
</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"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
|
|
|
object
|
|
|
|
</div></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> |