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

117 lines
44 KiB
Plaintext
Raw Blame History

---
id: create-subscription
sidebar_label: Create a Subscription
hide_title: true
hide_table_of_contents: true
api: eJztXAtz2zYS/is4Xm+aeETJkhU79kynp9hKo9axfZJ8no7taSESktBQpI4grage/ffbXYAvUbaVx7VpjtOZxiSBxWKf3y5B3VvBXIQ8koHfc60jywkFj8QgHiknlHO8bdWsiE+UdXRtDUM5mYhQWbc1yxXZiCNrOJWKdS56TM9XjDNfLJjK0WFRAHcjTYJx32WuGEsfxib3pH8XOMQKPIq49FSdDaeCRcu5YMG4SA1GiHBG8xdT6UyZE/hjOWHB6DfhRAzYCcV/YhkK9+jG32FvhsOLAoH0OZtG0fyYJuPA7p3wo1ehdCfigfEiG6GngYTwmVDRq8BdWkf3VrK0dRSFsahZwFsEk/ARn889qXfZ+E2h8O4t5UzFjONfuFUQp96EoasJXVtGTKCmmh5Xs3w+E6iMeYhajKRQSITuZsQUTPSRyaLK8jpmOKUOQ8R7Ppt7OKvjOELpTcPGCqKwVmu0Pmip3KPHVhQuGoySkWDvl7/jktn+n1ywd4L2ktiV4X1EJItrStc/4rSuna5LaxH58jLCj2eoCzQnuOz+u3s2fNXvnfzQhave2WnvDP8YHPd7F0P44+q8/9Pr0/OrssMURIKr1NnOztn5sLuzw3pjbfJgw7kFaiyaCr9sfXlTr+fnIo9mUmbihdEFUZgtRTKiyzyDQ5TCCq1RzcETxIngrgeu97QikpFsHITgobhUBONYv/uvy+5g+Eu/O7g4Pxt0N8SAGvA5hxVhu6A46bPe4Nx+ub/bZG6sAxYSnfGouI2LYfMNsTHmsRclN4D5TAbIdpFNI5tEMEyOywEjlWustOjWfbXohHHoPS2ey/4pGSoEOfEe4pnPvYYTqyiYwYYjMdH7LG4Q96GOGo3FYlE3d+sg2WSLJ1LNeeRM3wbuFvqhXSZqZTOYo2pM1sEaBz+fHddYR/8Dyjv5+azztndczzkBPoPLjvnXjEBbz7g1zxKrerPOoeG6E6OdRiYwDh/wvnXbMukDpEf7KBIxXtVxXYmX3GN33AMPZzO+ZCPBuOtqu8L54ziKQ1G/8W988CBwxF86l8M3O6huJTzQr3BrzA9QSyGHSdrycJWF9DwkB4TepBaWEnrVGfSON9HKxmoK0ne82BXsFVfSwY2kD6Mpu1RoGjNBWfOCK7UIQpdxoEeSUdly3U6/2/9leP5T92zbBQUPRTgM3gl/fVm6mS2TV70RENzJdogXufV1zEu8MJuQ2UZhat5CNlgD2MmoKJpN6XLNBUFsZ1vlQkQZcSJkxCkZA2tpEUf9c83t5kYjm9bxY8/jI5yqkUB53WR2aV127qeuiXEc1DmWwnO1XiMcj9RRQfhnEMFosGIfHgIKi1SBcRy5Wj3Fz4Y4mCmpEPuMttbMldS0yaCeVlZu2ofLURsxiAFnf5Zd5ww5rxX0+EQMn0M/qRw3Cm21KiJAzCkbovxt0XsyVZSR6jaZL4c5PiUB8oUCRBfEGvY+7n+dqwEzg9lZPBuBLp81W7YrJzICIeKN5yBhHrEp1wE/D9MveBj5MIXusUEQh45gfaHoj6L7Nlt77Rf7By8Pd5stlBAw2ReTrUAs8qjHfiwnbCB0tYHp2w0cVYfl63zGf4ccD7GkMREwGSCAhyVU1JiEjRAivqhPo5lHCIpDogKL8iQgcsAN/A6KJLRrk9rWQ5W9ADJ2s2RHOdXkRZCzo27JctCcfFwrH+ZGQeAJ7pdkdTUVIJqwaD5qGsTgHaFwhLwT8C/37EhiwC1hP4WIAzyGEtsQ649NY8BlGPcWfKmYYQ2ITnjoelhHEK4Caw3SUiPNRjoIpJLCS9jeWHoAwZ42hB8H52cXHPKjnoDODfVdgjK8JfH4LtvWgmD7e8SyCuUgUFlUJMNMXLuotm+uv3/2TV26GHGiZc9l333HbqzWbnOvdTB2edNptw9229zZbTZfNsXh/p7b3t9zbqznt0RGo8gTsK6ys69zDjYYz2Adbup8wqwpwHQhfHjo0XUFZjYPAJGSlULNRNbboPBim22qhiYKErPpgQKzW22uJy4CFfV1uUV2pfdODBOQK7Qf4CZZd1bZPlqbltz2saqyUFRuLgbTMGfqo2IZUZTYOiTfhMgTRPwQ6i2iog2YJ0M1ZTCSxyKW6EeT9j/2l3HvbxQBUvfV5p+Y+6cYHJLV0FstfeeL1lu5dk1KxU/WaOdrU2k+pX2ROi32XTbCnDz8KKb9QtbPZ8n/kTxXq1Wud0JRDmaWo/PZYw1T0wk1KcXhPqTHha47Mdm4bLQkNDKDxBskrdW0vM2TxWzzWfqR0i3orNiUTJ+c6atEshscsdS/lFt0+Ar9s95JMYXujpvNcYu37QPnsG23R+M9m7dGrn3Qbr14uTsWeyPdeagapZ/eKM1p+eky26xDZfZ265q99qvmbNWcrZqzVXO2as5WzdmqOVs1Z6vmbNWcrZqzf3ZztmrNfm2tWUt3K9q7uxvCkSfRc7phCAZgg+tgwNRhCX0tqYBHgbvESASy5p50P6nfUIxa+lTY8Vbg+TXATxswOrVBBLHswEQGFO+ki2XOLAAj1SRTnI/jijoHSdSbgPzcpAZlx2YzVP1y5x3Q2qbUvvQlzGfJFCZdihoPLCsOBB/t7x622uP9Nuetl+3mwYvR4Zjv7e0evjg8xNVnYLV8okVj1uZhyJelpX/A0CUd5oF/evJ3ckaudI2mF4cpMhIz9bQOiMaWqE2PTbdp+GURuEINwuWr4wvWPmAe9ycx3eeTNSH49uWghC9g55rwOZi33JgcEiR80n3duTzFYt/UtFYNaZUK/g4ABwgTYJbAKtjCNFgQx2YDC56B9TrbMVR3YEPcV/mBUl+ppQJhMhPUYIZZfcOMPGk2DqG2zLsS+c37iD3Dqq8GlQzcmyG0YIC3YUKgC6Qd7JLMI/vUSHKHTaG0h7T8YRUWFRZBHGFwl+vJORPlOl5LwshpXinoHMD5FpnbiWJgjraZ98LUWgyLRj/As5ZckbthTmgk0iWETgdRIUZ9JwhDPBQ6gr3JSDETjjQWnHE/GZdGrHx0pHD3VjNzEgX0zOGx2sLvLjwIPzZtLX2gk6vCJAk5Rkcj0kaiJhORMAFNta8ko1J1JY6vIW3lu5XvVr67pe+uP+wnXVP9lKDPhnczlz7WmUFIybMEfUKyHl+3CHCQrkW1IqlBZyDSj1dDXQfjeMCdSaP3M+EjncpLzHdSfej7I4QfqbIKukAGSY6mhwuRSLhHxHfGcfpOq727V17tdRCOJBiovwEiYoOGLYOY6oMw9n3khKsawF2h/G+xboP4qN8z6AiIq/qurSFuhSQrJFlloyobfTXZqEKSle9WvvvX9N1HkWTxUKPBSSqezXi41JZmnlOnmMGA7EVv6nLpUas8WkFiLMVYVhE5WKNWc9QcHzii7fK2u793OG45+y3+4qB50By1WwdWPtdfZ36cOlnRp3L61nokEQOIuwMcF/tgXCoKArfY/ovxXcoYw1ry1oxwM8gcRHqbYsfWYRk7DoOAveX+MkFIqoAhszc6FNNg7AzHhslYGMDZBOKizyBUSeALTQmb2DYLwWiYJ2eSnBd3AXTDpd0ZY7dVO0piZOkq5jWsokjgBYiaAzAsCZsUY8R8QIEQ7ASi82dEp0ZFn4TkWR93fIo7Zt33jhDo6Clyf7Gpv9vzdYeaDbSCH2j06mqH+2AAUBDomJXizgqfV/i8yvFVjv86cnyFzyvfrXz3r+m7H4DPDRp6GJ/DgK3xOYyt77IUS72mcw1/NEwnVzEckHmzwHHikNrNCQYHISgBN2W0pEXwIOOxNmU85oSeqeZH5gyBjaAfzM0u/CbKEagFgert6hY5xk8PYPF5oCgicSRiNVIK+ZkWLo4oU2+weLzhHvQO+l7V+Vymxy38YEFnHEYg7A1xDA8caJ/FAfRbNHqBOmkqlOgMOnISca235ARkeoziUcrJufVlEEOsJDI1PHhlDJNu4zlqqEq+VeZTAZRzaX+wr8vQW336XjShB/aySXyPrgbjGXC6tkXcwm1mKwOE8Hr1ksVkaQnLvlZpsXMc1mL5E4Hs2Y9Xw+dMn67CwBErxMxC0hklzi7ARCgwdpK3AjiJclUYxJMpMd4pvHdBR2RjDzbMbnw81nXdM0I4g4zRhxBPIi0eZL19ts3hGpBQo3ji8DklTqowcieP6ze+zU4kxjM6D4VjzBapYGTX82RfPLevj2Xi7wk123yjQdTU8zUutGivHX2Ox4FogCS4p0haH724pmfn6GE5BneQ6joPKAnDR/FtmZNo7aP5KNCzkV6Rjxv/in4pau3IqPlkypyA6zFnGgRKfM/oRCC6wfUkBi/6aLbo56ls8gi7tZtjydZL2tIGjEn8nYJj+NqY+AhzPEGcANCf72qX/JU0Cz7/K503/7WwZ7p9DakYR+I5sI/mGRe0cUFbxwBl+De/ywXMgm/jHigOaAM4zvRPkcAwmot7mtbGqE7kG8kZYeUAq0QFMpC+OMoCnPmL0QMcnY6BMIwQPX1/CNfM0MJ0VxBW0lxYl2CZXy+ALLsmN81v2tzCzPul7Rd33Ml6MOe+t/zcUfqBSPLlxN0/KeJVkeZrjDQGNGMvs5/93l83KW++9s/c/6iv3Om7kEc+VSl8jJJ8RPJlfwNeszBGka2akjQfGV8ZkF9uJOObjqmA/8NTCvBU1EHJrL8BQ+ibJzT3eIShkFKBM5WCWlBzwSPcUg3DUTCj8D0PAzQk/PFMJDShX+0Mwc65x0fSA3r0kiRZmVOU1dUIBgO8BrOmX9rEM/ZT7k9EnV0JJnyQd4gdATzmA89+C0xrYADufIHRgJ0kEQKQ+mwW+7AaBvN4xvDLjSfCiCuVE+ts5wS+LxJZBFQvpLOS0I/xCbdAn8SIcKbOxwNdyVpPH6c3a0GwUObVBog+5+jZRvrC40ldu91R/YQ2hCh7Krw5GgmkakDt+VDytjcsUQRivvloJQgnDTNJNXAsEMGaWpvPXr1Z37WpxsQP4aAqh3I9R/yYtA7FyOCRCHWfvdL5v/+VVxNqsd5tzLHji3I13xLrbkf6K61r3Q6on6fYFYEB9/fYFcTyf4W3IZBjy+n6Nqvs8Qo/vaXuILVH3gnsSpnXUfZQ/86CaT+V37Nhw0HP0B3HR8fmGzcX59h7tUbmV2xnOu6HfIGJBf5/ZN3Af3ARmG3BILp/byXtYRij6SZ4exPcNH/gNler/wLqvtxP
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 'Create a Subscription' (create-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"}>Create a Subscription</h1>
<MethodEndpoint method={"post"} path={"/trigger-subscriptions"}></MethodEndpoint>
This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required:
* HTTP subscriptions require httpConfig
* EventBridge subscriptions require eventBridgeConfig
## 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={"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={"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={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={"201"} value={"201"}><div>
New subscription to a trigger. The trigger can now be invoked by the method defined in the 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={"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