LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/update-subscription.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

136 lines
51 KiB
Plaintext
Raw Blame History

---
id: update-subscription
sidebar_label: Update a Subscription
hide_title: true
hide_table_of_contents: true
api: eJztXQtz2zYS/is4Xm8u8Yh6WbFjz3R6iq00ah3bJ8nn6dieFiIhCQ0fOoK0onr83293Ab4k2VYe1zQZTmZqkQQWi33h2yXA3lnhXEQ8lmHQd61DK5m7PBbDZKycSM7xtlWzYj5V1uGVNYrkdCoiZd3ULFfkLQ6t0Uwq1j3vM91fMc5i3ZipAi0mA9Z3RRDLeHkaLmosUTKYQuNJ4nksHP8unJhFYh4JBY2IqzrrByyMZ0BpEUauqjH4zcR7qWLoeh0wNiwNoJgT+nNPxMJbIimPO8KtsxF0moSeFy5wwIkUngtMRoJJ309iPvbE4XWA/xjbYdJNf5lJ9N30YTeOhT+PFYtD5oeunCyRHyVSksB54sU4z06zWQfZzXnEfeAmQgneWRKlNefxDB4F8ACupAu/lTMTPrcO76x4Oce7CoYOptZ9zYrEfxMZCdBOHCViVfKl2fePgZR4z1EA8Kw5abUmbd6x952Djt0ZT3Zt3h679n6n/eJlcyJ2x66w7m/0EELFr0J3iSysjuiEQQz6wEd8PvekQ5pp/K6Qg7t13rUicfIRWlcshcKner6rM3x0QtilXppT13GEQjkTxyXrQmGVaH3QUIVHj40oXFS9krFg75d/4JB6jPWxRJD46DVvRqNzuOz9p3c6ejXoH//Yg6v+6Un/FH8Mjwb98xH8uDwb/Pz65Oxy3blKbOIodbazc3o26u3ssP6E7qDdFwYgJwmYuAWtvYqkOxVHYTCRU2yWKrde7Is8mk6zOJ5vaF0SiZkSuDFdFhkcoRTIatU8DJQ4Ftz1ZLCF4tOW4KdR6sTorIPevy96w9Gvg97w/Ox02MsiiwxuQ22KtTxogH4wyAzP7Jd7zRZzEx3ckKjP4/I0zketN8TGhIPTpjeA+VwGyHaZTSObVDBMTkh65TiXyjVRWnSPO0YSeU+L52JwwsKJiX4QTwLuNZxExaEPE47FVM+zPEGchzpsNBaLRd3crYNk0ykeSwWhyJm9Dd0t9EOzTNWKwU9AMJZ1sMbhL6dHNdbVf0B5x7+cdt/2j+oFJ8BncNk1f00LtPWcW/Mstao3qxwarrsJ2mlsotDoAe9bta0JWJYi6dE8ykSMV3VdV+Il99gt98Dbmc+XbCwYd11tV9h/ksRJJOq4HoAHgSP+2r0YvdlBdSvhgX6FW2NBiFqKOHTSloejLCSsckAOCL3JLCwj9Ko77B9topW31RRk4HiJK9grrqSDE8kexjN2odA0fOA5cNk5VwpXTcaBHklG5cP1uoPe4NfR2c+9020HFLBiRqPwnQhWh6Wb+TBF1RsBwZ18hnhRGF/HvNQL8w65bZS6Fi1kgzWAnYzLonl6bQJHjU63Wp8QSSSpkGEp4DkDK0sVtvrXitvNjUY2jRMACEIksnmhx3HT3mvjsrMgc02M46BOAiRarzG2R+qoIPwZIsoCKw7goQO/VIlxbHl//xQ/G+JgrqRS7DPaWjFXUtMmg3paWYVuHy5HbcQgBuz9WWZdMOSiVgwcJTF8Dv1kctwotPsSUryiNWVDlL8pe0+uijWssNXKV8Acn7IA8oUClBUmGmM+7n/dyyEzjdlp4o9Bl89abduVUxmDEPHGc5Awj9mM64Dfy6cGETGKA+hC99gwTCJHsIFQ9KPsvq32bufF3v7Lg2arjRICJgdiuhWwRB5124/lhA2FYOny7YaOqsPwde7zP2CNh1jSmAroDBDAw3QrbkyjRgQRX9Rnse8RgjJJlQeJEuIGfssl2bVZ2lZDlb0AMnZrzY4KqimKoGBHvTXLQXMKcKximBuHoSd4sCary5mg7K5kPmoWJuAdkXCEvBXwl3t2LDHgrmE/hYgDPIYWthHmBJvaYKrHvQVfKmZYA6JTHrkeYnvCVWCtYQb/s9VIB4FMUngJ05tIDyDY04bw0/Ds9ByyPaY7oHNDMpWiDMhQkcd3+bQWBNvfI5ZVKAeByqKEGnri2GW1fXf1w7Pv6tJk1H2Xff89u7bazdZue3/i8pbT6ew3O9xptlovW+Jgb9ft7O0619bzGyKjUeQxWNe6s69yDjaY+GlSDr0Js2YA04Xw4aFH1xWY2TwEREpWKt2ArLdB4cU201QNTRQkZtMDBWZ3vzmfOE/igc68yKz01IlfwnGlSgXcJOPOk81H08U1r30s0ctCmMl9yilCWRqrcHsT2k7R7kOItox4NuCZHLGsA40izrDEIJ52/rG3TPp/I+/OXFObdmrKn2JMSFbDarUMnC+nlPWkM83xPlld3W9NX8W16M9XWLkashF8FEFBeTEurcXFtev/JKz7+/tCRYOCT7vZXI+ZF1T8dEvywYD90fWz4kJMZcKsHplK0lQRsyen+ioVwwaXuFkFX3JjMvJolbG8Cm1XZqx9s/W/TCdPDtg/JqhRroyPiWR5TFg3DzmNa2fjFsbaMlM141Cmut24Zq6D0phVfbOqb1b1zaq+WdU3q/pmVd+s6ptVfbOqb1b1zS9Q36yqm99addPSpYXOpmrCkSfRc3pRBAZgg+tgwNRhCX0tzYDHobvESASy5p50P6neUI5arohhukdbgefXAD9twOgSORTEsgMdGVC8lS6mOX4IRqpJZjgf25V1jrumWoD83DQHZUdmMpT9cucd0Nom1b4IJPRnaRcmXYoaDwwr9gUf7zUP2p3JXofz9stOa//F+GDCd3ebBy8ODnB0H6yWT7VozNg8ivhybegfMXRJh3ngn578g5yRK52j6cGhi4yFr57WAdHYErXpttk0Db8sBleoQbh8dXTOOvvM48E0oft8uiKEwL4YruELmLkmfAbmLTcuDikSPu697l6cYLJvclqrhrTWEv4ubgR00SyBVbCFWbggjs0EFjwH63W2Y6juwIR4oIoNpb5SSwXCZCaoQQ8z+oYeRdJsEkFuWXQl8pv3MXuGWV8NMhm45yO0YIC3oUOoE6QdrJLMY/vESHKHzSC1h2X5wzIsSizCJMbgLlcX51yUq3gtDSMnRaWgcwDnW6zcTpwAczTNohdm1mJYNPoBnrXkytyNCkIjkS4hdDqICjHqO2EU4UbOMcxNxoqZcKSxoM+DtF0WsYrRkcLdW83McRzSM4cnagu/O/cg/Ng0teyBXlwVLpKwxuhoRNpI1WQiEi5AM+0raatMXanja0hb+W7lu5Xvbum7qw8HadVUPyXo09rwIiXAPDOMaPFcgz4RWU+gSwTYSOeiWpFUoDMQ6afLkc6DsT3gzrTQ+5nwkV7K15jvZvrQ98cIPzJllXSBDJIcTQ0XIpFwD4nvnOPsBVSnubs+2uswGksw0GADRMQCDVuGCeUHURIEtNle1QDuChX8E/M2iI/6PYOOgDhq4Noa4lZIskKS1WpUrUbfzGpUIcnKdyvf/Tp991EkWd4YaHCSSnyfR0ttaeY5VYoZNMhf9GYul216KqIVJMYyjGWVkYM1brfGrcm+Izou77h7uweTtrPX5i/2W/utcae9bxXX+qvcjzMnK/tUQd9ajyRiAHG3gOOSAIxLxWHolst/Cb5LmWBYS9+aEW4GmYNIb3Ls2FnHjqdhDHMDwoAdowfKi/haHujD0EQe5aZL+ei0+sAmvQJASEkvduhoZgUdK+hYLT/V8vPNLD8VdKx8t/Ldr9N3Pwg6dp6Cjp0PgI4dhhBrghDrS0JHF3AHQrMJKAXm4CQg3mD1QxuZ28c8moo4A3olFNk+WEeRozBkb3mwTMGSKlUi831BFN6grY9to7QtNOBsCiEyYBC1JKBbtCrcCgGYFOyHedKXcfoJD6AbLe3uBN/Za59J7S0bxWzmUxQUvBBrryHYmARzEhOEf0CB6qBTCNSfscZptPVJ9WA2wBmf4IxZ770jBPp8Vv99sWmXQD/Q+xzYUOv6ge0CumbOA0gjxPu5Dl8ZBK2gegXVq+W+Wu6/jeW+guqV71a++3X67gdAdYOGHobq0GBrqA5t602WYanXtDv2z0bs5CqGAzJvFjqE1d0cg4MQlICbMl7SIHgc5kibMm6WR89U80OzE9VG/A/mZhf3HqtDUAsC1Rv88psvwC5xdvOEAhJ+me7QamQEih0bd9K9t5ABRJp6kuWNsnege9D5fZ3PZbZxNwgXtFt2DALfEMtw66r2W2xAHxHUA9RJW5FEh9DRk4hr3aVnabINuY9STk9ALiGjYZpMDbfwG+Ok23giDzKTfypz6BRlvTY/mNdF5N1/+lw0oQfmskl8j44G7RlwujJFnMJNbi9DhPF69DWryZcmfIHQXhvsDJu1WfFsCXv20+XoOdP79DF46G85ConZBrjfOZgIBcduur8EO9F6FYXJdEaMd0s7eNAZ2cSDCbPrAA8IXBU+FskGEOZJpOUjUTfPttmmDRJqlM+uPKfFk7KMwhm2+nVgs2OJMY121mMbM0X9pcqreTovXpjXxzLx95SabU77EjX1fIULLdorR+8IdyAiIAnuKZLWRw+u6dkFepiSwR2kusoDSsLwUd535aRa+2g+SvRspFfm4zq4nElYmVcOH+nYlZ6l6DNnFoZK/MDobAm6wdU0AS/6aLYWOKhNHmG3mwWWbD2kLW3AmcTfCThGoI2Jj3GdJ5gT6ooLueRvpFnw+d/o5OJvpTnT7StYjrElnij4aJ5xQBsHtHUMUIZ/vdqhYYFv4xwoDmgDOMr1T5HAMFqIe5rWxqhO5BvpaTPlAKtEBVYhfXGYBzjzi9EDbJ21gTCMMD3biQbXzNDCJa8krLTAsCrBdX69EFbaFblpfrPXpLj6/tXmizPu5nWYs8Bbfu4o/UAk+evE3S8U8apI8y1GGgOcsZ45yL903EtTnK/6u0R/1meJ6PjwIyeaS2eW07PGf+3v+tQsDEBkiCbnLIa9VwbBr1eK8VUGffMbnlL0pqwNcmL9qQDEtUVCc4/HGOcozjszKajGNBecPjtew1gT+hSb51GIRiWUJjSNoA2eHIUshY+lB/ToLUg6Mn2+PNCpBno6XoPN6j05IQQpHkxFnV1C2h+AvCNM+XE3ODz7PTS5/xB89RxdnR2n7g8w3PeTAEbDSJ34DA/4PhEjXKmcRC9lThgEIpWF/nB71iuN6xh8cAp0clpEvjqbDHWqaj196tKMBZFAmXcXIPqCF+cTGQhPH5C1tj3RmdKG+GPPhDdHI4F1GCB5MU687Y/WKAKxwLwwC6Npw3RSDWwLRDBh1uazW2/VmzYlkPi9hFDFkI8XiOuPSEGmMXwk/Nzl72yqb+8/+O19E4QxzW3MsdiLEjcfo9GVjitrY6UD+h5KFw+Bz0A/2OzuDsuCmPvf420I+lhzurrJ03oqh4D9mDg1gTVu9esKRa09G5hD6M/Zyse1HmI8rWUHy7yMZcHPdwKrX8Du/Q1+QYbKk8SMfmDeh9kj/bmwtOPaiz6sdugeuuT5aNti5ej8Ar1hbP7fAb5eliK+wHUP/ntoXcM/uAiNbKER3b+z0vI0tNFkU6y/CeqaHyBzaPY/GuVS0A==
sidebar_class_name: "put 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 'Update a Subscription' (update-subscription)"
---
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"}>Update a Subscription</h1>
<MethodEndpoint method={"put"} path={"/trigger-subscriptions/{id}"}></MethodEndpoint>
This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing
Subscription is completely replaced. The following fields are immutable:
* id
* triggerId
Attempts to modify these fields result in 400.
## 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":"Subscription ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"}}></ParamsItem></ul></div></details><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={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Subscription name.","example":"Access request subscription"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Subscription description.","example":"Access requested to site xyz"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"SubscriptionType"} qualifierMessage={"**Possible values:** [`HTTP`, `EVENTBRIDGE`, `INLINE`, `SCRIPT`, `WORKFLOW`]"} schema={{"type":"string","enum":["HTTP","EVENTBRIDGE","INLINE","SCRIPT","WORKFLOW"],"description":"Subscription type. **NOTE** If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required.","example":"HTTP","title":"SubscriptionType"}}></SchemaItem><SchemaItem collapsible={false} name={"responseDeadline"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format.","example":"PT1H","default":"PT1H"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>httpConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Config required if HTTP subscription type is used.
</div><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the external/custom integration.","example":"https://www.example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"httpDispatchMode"} required={true} schemaName={"HttpDispatchMode"} qualifierMessage={"**Possible values:** [`SYNC`, `ASYNC`, `DYNAMIC`]"} schema={{"type":"string","description":"HTTP response modes, i.e. SYNC, ASYNC, or DYNAMIC.","enum":["SYNC","ASYNC","DYNAMIC"],"example":"SYNC","title":"HttpDispatchMode"}}></SchemaItem><SchemaItem collapsible={false} name={"httpAuthenticationType"} required={false} schemaName={"HttpAuthenticationType"} qualifierMessage={"**Possible values:** [`NO_AUTH`, `BASIC_AUTH`, `BEARER_TOKEN`]"} schema={{"type":"string","description":"Defines the HTTP Authentication type. Additional values may be added in the future.\n\nIf *NO_AUTH* is selected, no extra information will be in HttpConfig.\n\nIf *BASIC_AUTH* is selected, HttpConfig will include BasicAuthConfig with Username and Password as strings.\n\nIf *BEARER_TOKEN* is selected, HttpConfig will include BearerTokenAuthConfig with Token as string.","enum":["NO_AUTH","BASIC_AUTH","BEARER_TOKEN"],"default":"NO_AUTH","example":"BASIC_AUTH","title":"HttpAuthenticationType"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>basicAuthConfig</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Config required if BASIC_AUTH is used.
</div><SchemaItem collapsible={false} name={"userName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The username to authenticate.","example":"user@example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"password"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The password to authenticate. On response, this field is set to null as to not return secrets.","example":null}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>bearerTokenAuthConfig</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets.
</div><SchemaItem collapsible={false} name={"bearerToken"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Bearer token","example":null}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>eventBridgeConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Config required if EVENTBRIDGE subscription type is used.
</div><SchemaItem collapsible={false} name={"awsAccount"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource.","example":"123456789012"}}></SchemaItem><SchemaItem collapsible={false} name={"awsRegion"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values.","example":"us-west-1"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether subscription should receive real-time trigger invocations or not.\n\nTest trigger invocations are always enabled regardless of this option.","default":true,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"filter"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath filter to conditionally invoke trigger when expression evaluates to true.","example":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]","externalDocs":{"description":"JSONPath filter documentation","url":"https://developer.sailpoint.com/idn/docs/event-triggers/filtering-events"}}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
Updated subscription.
</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={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Subscription ID.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Subscription name.","example":"Access request subscription"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Subscription description.","example":"Access requested to site xyz"}}></SchemaItem><SchemaItem collapsible={false} name={"triggerId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of trigger subscribed to.","example":"idn:access-requested"}}></SchemaItem><SchemaItem collapsible={false} name={"triggerName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Trigger name of trigger subscribed to.","example":"Access Requested"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"SubscriptionType"} qualifierMessage={"**Possible values:** [`HTTP`, `EVENTBRIDGE`, `INLINE`, `SCRIPT`, `WORKFLOW`]"} schema={{"type":"string","enum":["HTTP","EVENTBRIDGE","INLINE","SCRIPT","WORKFLOW"],"description":"Subscription type. **NOTE** If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required.","example":"HTTP","title":"SubscriptionType"}}></SchemaItem><SchemaItem collapsible={false} name={"responseDeadline"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format.","example":"PT1H","default":"PT1H"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>httpConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Config required if HTTP subscription type is used.
</div><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of the external/custom integration.","example":"https://www.example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"httpDispatchMode"} required={true} schemaName={"HttpDispatchMode"} qualifierMessage={"**Possible values:** [`SYNC`, `ASYNC`, `DYNAMIC`]"} schema={{"type":"string","description":"HTTP response modes, i.e. SYNC, ASYNC, or DYNAMIC.","enum":["SYNC","ASYNC","DYNAMIC"],"example":"SYNC","title":"HttpDispatchMode"}}></SchemaItem><SchemaItem collapsible={false} name={"httpAuthenticationType"} required={false} schemaName={"HttpAuthenticationType"} qualifierMessage={"**Possible values:** [`NO_AUTH`, `BASIC_AUTH`, `BEARER_TOKEN`]"} schema={{"type":"string","description":"Defines the HTTP Authentication type. Additional values may be added in the future.\n\nIf *NO_AUTH* is selected, no extra information will be in HttpConfig.\n\nIf *BASIC_AUTH* is selected, HttpConfig will include BasicAuthConfig with Username and Password as strings.\n\nIf *BEARER_TOKEN* is selected, HttpConfig will include BearerTokenAuthConfig with Token as string.","enum":["NO_AUTH","BASIC_AUTH","BEARER_TOKEN"],"default":"NO_AUTH","example":"BASIC_AUTH","title":"HttpAuthenticationType"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>basicAuthConfig</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Config required if BASIC_AUTH is used.
</div><SchemaItem collapsible={false} name={"userName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The username to authenticate.","example":"user@example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"password"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The password to authenticate. On response, this field is set to null as to not return secrets.","example":null}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>bearerTokenAuthConfig</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets.
</div><SchemaItem collapsible={false} name={"bearerToken"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Bearer token","example":null}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>eventBridgeConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Config required if EVENTBRIDGE subscription type is used.
</div><SchemaItem collapsible={false} name={"awsAccount"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource.","example":"123456789012"}}></SchemaItem><SchemaItem collapsible={false} name={"awsRegion"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values.","example":"us-west-1"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether subscription should receive real-time trigger invocations or not.\nTest trigger invocations are always enabled regardless of this option.","default":true,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"filter"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSONPath filter to conditionally invoke trigger when expression evaluates to true.","example":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]","externalDocs":{"description":"JSONPath filter documentation","url":"https://developer.sailpoint.com/idn/docs/event-triggers/filtering-events"}}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde\",\n \"name\": \"Access request subscription\",\n \"description\": \"Access requested to site xyz\",\n \"triggerId\": \"idn:access-requested\",\n \"triggerName\": \"Access Requested\",\n \"type\": \"HTTP\",\n \"responseDeadline\": \"PT1H\",\n \"httpConfig\": {\n \"url\": \"https://www.example.com\",\n \"httpDispatchMode\": \"SYNC\",\n \"httpAuthenticationType\": \"BASIC_AUTH\",\n \"basicAuthConfig\": {\n \"userName\": \"user@example.com\",\n \"password\": null\n },\n \"bearerTokenAuthConfig\": {\n \"bearerToken\": null\n }\n },\n \"eventBridgeConfig\": {\n \"awsAccount\": \"123456789012\",\n \"awsRegion\": \"us-west-1\"\n },\n \"enabled\": true,\n \"filter\": \"$[?($.identityId == \\\"201327fda1c44704ac01181e963d463c\\\")]\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
Client Error - Returned if the request body is invalid.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"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"}><Markdown> An example of a 404 response object</Markdown><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"}><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>
Reference in New Issue View Git Blame Copy Permalink