mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
133 lines
46 KiB
Plaintext
133 lines
46 KiB
Plaintext
---
|
|
id: patch-subscription
|
|
sidebar_label: Patch a Subscription
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXI1v27YS/1cIvQFrM8uOHTdpAgx7buKu3tIkz3ZeMCTBRkuUzVUWPVGK4wX539/dkfqy3Xy0xdtWGAUaSyLvjvfFH0+k7hw1EzFPpIp6vnPgzHjiTQbpSHuxnOFdp+YkfKydg0tnGMvxWMTaua45vihaHDjDidSsc9Zj6cznidCMs8Q0ZrpEi8mI9XwRJTJZnKh5jaVaRmNorEXCVACPdRKnHjbVLFFsqnwZLPB5mciMx4nkYbios+FEsECFoZojnUCK0AfesWA0DD4KxcFVdBVtbUV8Kra2amxrqyS4uSEibOebi2Qxs+0CGSYiNr9joWcgkjgS3A9lZFtMkmR2qKJAji2hGxjZm1j6Y1G+PVfxhwAkzO6BQmEEIE+Cqjy4vHNkZBQ/gUcoKFxJH35rbyKm3Dm4c1AsuAvagXE69zUnFn+kMhZgMVCYWDZH7wi1mYByypZEjZJegLS45dNZiDS3g2YzaPG2u+ftt932KNhxeWvku3vt1qvX24HYGfnCub82LIVO3ih/gSItS+CpKIHx4yM+m4XSI59q/K5V5BLX7/AnPi6GVZX6NHNEsv1IMKIjUBN2/DyO+QIuZSKmuqQXNfpdeImzrIYO+2lwenKGzFlOnHHNfBGAFX02WrDL/ttDtru/3WIutWbU/PoFGlcfNBqJUqGuS5EEdRWPG5NkGjbiwMMeL52yHS4hkMi0YEbQ1izGuEqkIDnh0YoVV2NIsDwWrQbgMlDxlHQgonSKbLjvE+OpuhH0YxZyD3/ZG56aLVCCwsRZk3sr3qOidJh5YDWiJJg2ZkAGAgGjF56gcyU8HkPgIk2Ul0dMhGIKDTL7BQGYxeg5KY+u4oCNMm8Q8YaHqSA3ihanAQXIsvvnd1AwSDLlW9YXSneM19yvSVqCETMrbqpBVFB3VdYay2xMz65Q/1cODNaH31azcJ2315XBnYg5q4zv/r70+NJ4RsmGxj5VneQqAbtEy/RqHyVBmWS5L91EVUAKJgHLCYJcv2/CHCWlPGMyH3lxa3t7NWrPKeP7lRRddx7MB9UksBzD5ZCiNGhnkl6eCGyWzJ+cmCubyJ1C6ixfrwYkEH40Ciq5s3dU/4S0meXzZ7HCLlVmHc8TWjObgSuqRh4VWs9iVXr0EEcwL4SIhrTLbhd/IsvCJo8ytJNRFQ6MiGSVp/SjA0583ZxvidfJkzRpMQop8Yl87Vj7FZ7EZJVZloTfDYdncNn9b/dk+KbfO/qxC1e9k+PeCf4YHPZ7Z0P4cXHa//nt8enFKmKqTszApQ5Q4eR02N3aYr2A7jDAVCUGNcxLkGKXUQY2y2KmXu6LMtpOBVSptK6owQ5pXWIYohbu18TVo+bIWlLu9BSyoumj3/3PeXcw/LXfHZydngy6uZ1kdKO8PPHaCQeMhshxcOq+3t1uMj+1kyTOjTypDuNs2HxHYgQ8DZPsBghf6GA1iVnd5JleBqS9Ku7M9IrzRL0AJXniqmaYNA4fV895/zhDauIW5tiIhw0v1YmaMprazDirA8yQyXw+r9u7ddBsNsQjqQluvVf+E+xDo8zMinhb6BqTdfDGwS8nhzXWMX/AeEe/nHTe9w7rpSDAZ3DZsX9tiyr2sM8yr3q3LKGVupOinyZ2lhh+JPqWfQtRnCbt0TiqRGxUdXxf4iUPzWSv2ZQvCJ34vvEr7B+kSRqLOi4WIIIgEH/tnA/fbaG5NYAaRDE1Fim0Usyhk/E85DKXYYjkgNC73MNyQm86g97hOlpFW0NBRl6Y+oK94Vp6OJD8IYCrc42uAQkNUccZ1xrWFD4CWaMZXbDrdvrd/q/D05+7J09lKGC9FA/VBxEts6WbBZuy6a2C4E4xQrwo8Tc5L4vCokPhG5WuZQ9Z4w3gJ6OqatZhh6UQ1E+eNSYE/4ySEcoWAixNxdjq30thN7MWWccnSsMQYcn6hRryzXqv8GWnUR6amMfBnLTCNXYlkI3U0UD4UyXQGrw4goce/NIVwbElArqH5VmTBwsjVXKftdaSu5KZ1jnU48YqdXu+Ho0Tgxqw9xcZdcmRy1ahIoZVw5ewT67HtUq7v6/CYZxT1mT562r0FKZYwQpPmvlKmONzJkA+14CsVGrWAI8sOC8GzDZmJ+l0BLZ80Wy5vhzLBJSIN16ChnnCJtwk/G4xNMiIcRJBF7rHBiqNPQFwTtOPavg2WzvtV7t7r/e3my3UEAjZF+MnAWeU0bT9VEnYQAiWTd++8nQd2Nf5lP8JczzkksZYQGeAACHW0JLGOG7EkPFFHasOhKA4TFTgUaHUVC/jN1ySX9upbTlVuXMg4zZX/KhkmrIKSn7UXfGc+2KBVahqpFQoeLSiq4uJANUsFf/0RKUQHbHwhLwR8JeHbiIx4a5gP42IAyIGJrYhrnjWtcAyHw/nfKGZFQxIjnnsh4jmCVWBr6p8cZPPRSYF5HrCSxicqfc97ga2pDRhpgOGNix1M4wRLkjGD8Wg5gTabxHJatSCQFNRjRR6Iu+q0b65/OHFN3Vpi6Q9n33/PbuClXdzp7UX+Lzptdt7223ubTebr5tif3fHb+/ueFfOy2siYzDkEfjWaqgvSw4emGK1JivJEGLN4aUPySPEeK5rcLIZ1oDIR2GVRr7boOTi2mHqhiEKGnPpgTaljnWrCVtaaK+rJhyGEiOnG8fgAC6EDiZMk5Yw1rIV8Ej5C8xEoGseSv+z6g3VrOWLBIZ7+CTw/BbgpwsYnWqJgkT2oCMDijfSx2XOVIGTGpI5zsd2VZuDJupNQH5+tgZlh3YwtPrl3geg9ZSl9nkk/8Bylu3CZFHPWsNW7Ak+2t3eb7WD3Tbnrdft5t6r0X7Ad3a291/t7yP3KXgtH4tysTUrwlZZ/4ipS3oshPgM5Z8UjFybNZph/lDdtmoDovFE1Gba5sO08rIEQqEG6fLN4Rlr77GQR+OU7vPxkhIi93ywgi9g5IbwKbi3XDs5ZEj4qPu2c36Mi327pnVqSGtlwd/Btx8+uiWICr4wUXOS2A5gzguwXmdbluoWDIhHutxQmiu90KBMZpMa9LDc1/Qok2ZBDGvLcihR3Nwm7AWu+mqwkoF7UyqZA96GDsoskLawSjJL3GOryS02gaU9TMvPW2HRwkKlCSZ3uTw5F6pcxmtZGjkuGwWDAyR/wsztJSkIR8MsR2HuLVZEax+Q2WiuKt2wpDRS6QJSp4eoELO+p2KY2CAzwdhkoplNRwYLTnmUtcszVjk7Urp7b4Q5ShQ983iqnxB3ZyGkH5eGlj8wk6u2L1JMNiJrZGayGQknoImJlaxVbq4s8A2k3cTuJnY3sfvE2F1+2M+qpuYpQZ/mmhcpEa4zVUyT5wr0icl7IlMiwEZmLWoMSQU6C5F+uhiadTC2B9yZFXq/ED4yU/mK8J3cHub+KHtHmE39hS1QQNKjreFCJhL+AcldSEyKMqraWeX2VsUjCQ4arYGIWKBhC5XS+iBOo4h2GOgawF2ho29x3Qb50bxnMBkQuUa+ayDuBklukORmNtrMRl/NbLRBkpvY3cTuPzN2H0SSuVQULRYn6XQ65fHCeJp9TpViBg2KF715yOWbrcpoBYmxHGM5VeTgjFrNUTPY80Tb521/d2c/aHm7Lf5qr7nXHLVbe055rr8s4jgPsmpMlext7EgqBhB3AzgujcC5dKKUXy3/pfguJcC0lr01I9wMOgeVXhfYsb2KHU9UAmMDwoAd44+UF/G1PNAH1kQe9WZK+Ri0pDrzCgAhJb3YEbdSJxvouIGOm+lnM/18NdPPBjpuYncTu//M2H0WdGw/Bh3bz4CObYYQK0CI9VdCRx9wB0KzAIwCY/BSUG+UFHtK8x2k5aMMcb5ppIQiW/urKHKoFHvPo0UGlnSlElnsC6L0Bm2n2DbO2kIDzsaQIiM84SEB3aJX4VYIwKTgPyyUU0lxjAMCuvHC7QT4zt7ETOZvORe7mU9TUggV1l4V+JgEdxIBwj+gQHXQMSTqL1jjtNb6rHow6+OIj3HErHvrCYExn9d/X63bJdCLzD4HNjC2/sh2AVMz5xEsI8TtzKSvHIJuoPoGqm+m+810/3VM9xuovondTez+M2P3GVDdoqGPQ3Vo8GSoDm3r2yzHUm9pd+z/G7FTqFgJyL2Z8gir+wUGByVoATdlsiAmeBzm0LgybpbHyNSzA7sT1UX8D+7mlvce6wMwCwLVazz7OhXgl/nHDpziyGxOoty1cSf9ewdFQKxphlndKnsH1ger39f5TOZbdyM1p/2yI1D5mmyGm1dN5GID+naCYVAne8USQ8LkTyJurJedpsm35D5IOTsDuYA1DTNkariJ37on3cYzebA2+VbbY6eo7ZXxwbjO4/D+88diCH1kLOvU9yA3aM9A0qUh4hCuC48ZIJA33Ff8ppic8BVCa4XZKTZrsfLpEvbip4vhS2Z26mP6MJ+wEBLXGxCAZ+AilB472Q4T7EQzVqzS8YQE71T28GA4MvxCRJ1dRXhE4LL0jQzWh0RPKq0eiiq+UPDQRm3QUKN6euUlTZ+0ziidYqtfRS47kpjVaG89trFDNB/ouJxl4+KlcX2qEP/KqLn2vC9R0y+XpDCqvfTMnnAPcgKS4KEmbX0yc0PPLdHDRRncQarLMqAmrBzVnVdeZrVPlqNCz0V6VTmuoouJhLl56fiRyV7ZaYoe8yZKafEDo9MlGAaX4xSi6JPFmiNTlyLCbW2XRHINS1e6gDRJvmMIjMg4Ex/hTE9AR5maC4Xkb2RZiPnf6Ozib5Ux0+1LmJCxJZ4p+GSZkaGLDF2TA7SV38x36FgQ2zgGygPGAQ4L+1MmsIKW8p6htTarE/lGdt5MeyAqUYF5yFwcFAnO/mL0AFvnbSANI1DP96LBNbO0cNKrKCsrMSxrcFXeUMFcu6Q3I2/+ohTn37/beHHEnaIScxqFiy+dpT+SSf4+efcvynibTPM1ZhoLnbGi2S++3dT9G3x8BiOANGGXPeW4e2Mh5GqxEqvpEwH/w1NKH7RwgGWZOa2OwKpMCERKMNAo0XgTKajMMRM8QThaQ2dXU0oOs1hhRoLFLBEax9AGDy8CTOYjGQI9KsRnnDnFsMG66Gp4DSsGsy1EQZTAslnU2QWsPCMPPAVXnbghGZ79ruzycwDOQt9VYkeZ/wEOnE7TCLhhqkinDM+YPuKkvtReanIpLEIjkelCERrNe2WJBb0fh0CHd0U81afBwKyWnMcP/lle4Irals9B9WhF+8myYiB9EeafQnraocKMNgSAOxHhDNe9MBEAJhQlDu97wxWKQCyy72zw+1y2k25gW/yYFAzeuM9OvVnfdmkFg0f2lU5gSVgibj4TxtnSt++Wvq2TvzXYfPLueZ+8s1M4rr0aM6xBohXsN1JM0rh01i6/oe+B9PFs8gRshs3u7rBahQvSe7wNmQ1LIZfXxVqTkhv4lD2uHEDiXT70Xzbli749G/2SPf7lvLUDyUqu0aKU9ODnB4FFGhD//ho/dEJVNBLOPLCvbdyh+apV1vGh7+dhzjWdTZHugW5OpdZx1hke4nc2Rvb7fVNTBIr5HG7i/wfOFfyDC2UVD43o/p2TlVShjSGcodN14Mz+AINAs/8BsT6usg==
|
|
sidebar_class_name: "patch 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 'Patch a Subscription' (patch-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"}>Patch a Subscription</h1>
|
|
|
|
<MethodEndpoint method={"patch"} path={"/trigger-subscriptions/{id}"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable:
|
|
|
|
**name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig**
|
|
|
|
## 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":"ID of the Subscription to patch","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json-patch+json"} value={"application/json-patch+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><span style={{"opacity":"0.6"}}> array</span><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"op"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`add`, `remove`, `replace`, `move`, `copy`]"} schema={{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy"],"example":"replace"}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>value</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The value to be used for the operation, required for "add" and "replace" operations
|
|
|
|
</div></div><div><span className={"badge badge--info"}>anyOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
|
|
|
string
|
|
|
|
</div></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
|
|
|
integer
|
|
|
|
</div></TabItem><TabItem label={"MOD4"} value={"3-item-properties"}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><div><span className={"badge badge--info"}>anyOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
|
|
|
string
|
|
|
|
</div></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
|
|
|
integer
|
|
|
|
</div></TabItem></SchemaTabs></div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></TabItem></SchemaTabs></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></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> |