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
e8c6d4aad70eef6d6870aafd342c04847f4cdba0
developer.sailpoint.com/docs/api/v3/patch-service-desk-integration.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

154 lines
54 KiB
Plaintext
Raw Blame History

---
id: patch-service-desk-integration
sidebar_label: Service Desk Integration Update PATCH
hide_title: true
hide_table_of_contents: true
api: eJztPGlz4zayfwXL92HseZas07K0k6Q0tmfjlGfs9ZGpXctVA5GghAxF6hGkbcXl//66GwAPXT4yld1MKZXyiCTQ6LsbjePBiaYi5omMwmPP6TlTnrjjCxHfSlccCvX1OEzESH93dpyEj5TTu3ZMA4YtWLHJzY7jCeXGckqPPedq6vFEMB4ycS9VIsMRWw6dDWfs+JDdyWTMODvrXx78zGLxf6lQSRVGnvKYT0QiYhz/wQnhAaBLDz7JUOM9duYHB3iRz5KxYCWEZWHUJGIpoQidcTgZC2BDEqdix1HJLMBRlJxMA2wg7qdB5MErnwcKG7hjMeFO78FJZlNqmcRAIbXk1KfncOTr4+ONBg/UvI+8GXaZH62Mep8FwC5E/+Lw+KPBkWWyUoy7bhR7yE8gAUm8/uXi9BM7Q/ndbI2TZKp6u7tJFAWqKkXiV6N4tDtOJsFu7Lt73Vpjm6mEhx6PveogHISnYTBjX2IxDbgrvpRGigWOJqaJ8FBKyVgqJkJvGgEjqW+ftWpN9iGKh9LzRMiO4jiKgc2edAFrBT14wmZRyniSiAnBAaS1jHk+lG4HwMMoYTwIojuBuAE73QhEFibINj6dBggW2u/+pqKwQhr7v/gTPy+IJBr+JtxkQTX6DNlF3GJe5KYTAM+4Yp7wZajpvD7/cMCQU6zCXsrbKmOvZSgqe4ytEykUEpL3xKcyGac5VODoEOAiewSahaGfxzGfoZUA59XL+JIB/4aMKZnZNdBGtg22e7NI9jLDKmN7ORZF9SEOwKMfxRPigQjTCQ7DPY8GnkS32tBJKPDLvHCjKfIIdDVBRHLrtS0fDZZPYtRn+oNhDEpUxODIprFQoGJkr4B0wuORSBjCRLTRPQaCdNCI0fdBOlY9CkSWfMtucWxA8ZYHqSDeheLUJ0e52jF9Enes2B/Il0lQaPy4k3UnjyniYv9mrZb3sN8LXTL9sm2yFxkIMOYEhhqmiZa4cerTsQzkFHxmAZrVYgtMPz8uhBtUCOKC4WOqgIegDmUm7jCrg/RtgPoxcEAKHvw2IofnguGtYxzgmeH1C7ghsobMdoiOQu/rQcjYA/5hMFg0HTi94qA79guqhv62G92FIj4XfuEr0YifDSR8Jz3dvuF26/u1/b2OV2sPG41OrQ6/ut1GnTfgRcvLwGAn5K/udnx49Ony+PJfpc8oEv25H45EEDUY2oiIB45u84j/wJ8bJPMRLUtNgV9ano1abdFjLY/+h2gEyoQ5b73HL7t5iBNlVV/h2FZlAG8UU1PhSt8MUZ3zUKSUZWDGt+4U1XfBfUFq8qSzuAolpARMeugZfAmOwqrqKmxLirjX6LbavNXdE36rVavvd4d1v9YUzb1Gs1Wvu/voErRNrRDCMmZghypDO8JfbJJCFoKGRKhW87iyxKOsygrZJ0QCkHFjQeJdwhh02RzE7aACVBK5wHRt2yaZhPwBWqzP7O5An+yARSwbtUarUqtX6p3L+n6v1e412tVut/VvRHASeSiHPxHDgAN/s2EX8WxU6vuLeJaGfYFwCw3Xi7LPbkU8YyHCWamLjxbCczFg2Fz1MGWsWLCfojvMcMtvBuES7CAD4WmQ5PBN12U6aD8BitZ7vsRZnGIf4Je2zGS2mJRZwtcbuIVzeHlKtFcLOYn1t+WEI3sLmD/HhcxjCnOoalmNKBrw1p7PuScE+Ik9f9gS4C7cRm2v2S06iecN5UkFwWqmPUWZ+el0GsVJKSJSL3DvEKzRAwQpho8XiuMiSmNQJ9P5tcIoQ1kqk4OTq4vLo/OySOzLZ0pkbpjl8thvdXjHd13Pg+jMeXu/u+d3/Za/5z9fHnMDrRbLZcxliJnnr/2SaDSAA91/XkSLVn2QUfRkmGJbJqGhBDYXOiZeCad5BIIYcvfrHUxAmRtNIN+RQ0j8ktn2etd0P/v991m32yV+QFrt6pCiJ9FhGgR8iO3wGT06D/lIeJrUJRMow8TjQ/VCokADb6WC14DfQRT6clS1Y50LRVCBYLXDID/IqR4LmPs9j/RVE7csO19Cfsala6tnzbZX79b5/l6t3vYa+602ZIC80Wwg+xpue6/QpN3Zy5t09xtNB9Vhkc5FJmLce7PY8A0zZjqzKRbVAkBl6XNq2Eo5OuR/GYAi01WBI5l3KFs/pCYQrBQPPhL/l2juRTb63VgAArGecpfRgBcWEy3IkohtLUqrCTgupmUMz3E00dOLeATT/mOfkSxYaOF4RX3Qk39T28hJG8KUWfCQck/uYekgLwuZqGdqTpmIywpeHGORAfAWFC9EdIG8DPOnFB6LNQHoF5D1ETxLhBUNyAWtMD0mfTbPfeQjobpOlV/o+BHRp5F8ZViwcQBrbSofT5nxvHXj2bhxcXp1fnBUDhvm3TOjhi5Vvnj8+bCyzNyHYO78+WHl5xRUqoJqiI5UzwL+EGo/n7O+m4CWsEOYVLlJFM/KYSifEWp56ziU+7IMY8NSzVFLcptIdttdIhl+iWGtXYf/HEux83HGjCbViyWK54NrwH/LwDU0qkB0eBzKRPJA/i7iC+LmMjcJtgH/c3Amxh6p+MOwPzAyA8B0r2Wurxzg5jVeC2ndyOdpIHSdlZyQKjs5GYJSpC4J0x1zmPKr9cH43U/3kwDnCgjhhzf1au0NA7oiLEz/8Obq8kNl/81PPw4G8WAQvvvb4enB5b/OjjQSZ1fvT44P2GAwcBSXgS5+eomHL5a/tXCoO8riB3x7pJEhoNQXsaUv7wVoqzgrEFiAwti7w5xHP+q2rNhYo3k3lu7YMgOTLOS+ohmeCPVvkiHN4WbVd7tFqNlQWl9+fPe364PD/mX/Wn+QE0yXWU6oFnP17d/Xfy9ieQa6U+27bpSGybmOUX+sdzUrXb0Yji2HvA6Plw43j6f+iw5qi5VJosWSwmOPLK46Ekm5ndraZtvswUoNotvWXFfsczrd2q7CIwS5LbaIFWGb4VY91BrDSpDZPFhFYJ+G9pG0jG3/3UJ6/KbIHoV/Aq6PRXExdnPz47tdYx8DUy4NoyJ0K51Fv/bJBCdwn1ktTns3SPRCSsRyk8VUR/FbtGzosmQApjWNssRQgFMjNdEpm6La/DiO0tFYZ4+FwLc0kXsqcZsuInB0P5WmtrJA6mckyKA/FaFXyklp/Qip9HY0cnq1RtMMOcoQaAGax8Bl/c70pJigk1H0YgEG6aH2hJI+QoqspCewUi4QOfgXPR/ktkEUYranFyqUDmE4l5HBPEvyxYOshAavmo1iIOkUE4KzxSnH487cWsGzS155tyr7FcKrp1MVJCzBeXGCrAPE3HyxhZZ7cTFmnpIsCnPPk/iNB2eF+Ds3B3uwwRlyebM0s+N8FfkT0jxciFEYdV6SI6+KXK/Nh1dGwmUFk/Ork7m0l948M+ldOdR80aTW2hfDptduu23e6rT3h16t47nucL/TadXdzv7zs1sCv7pUsgyjvowTcoskmaKiLiYY2MRUUmjNf0mOW171MOsmrWVLJQeBRK+jV9Mr7FwkaRzqWVfRhoeRN2PkkG5Rv6svWT1ZP7P2sGwRHNCWh6cY+wH8TWUU6zKHIJQhDTSTaPJWE+SsBmm3ZVC7sgSAE9U6e889Zr3ygSEGGR9z9yvAOn7+4ortwmS+ELhkWNERfLhX6zZa/l6Lc5g61TvtYdfnzWat2+5SmXQilIIpbrEYY2e25aH/AeEjli74SJcSeg9kxYH3hAANvm5BviwDgvEM/mMNRrfNyDT4wrTsPtmBFPX9wRlrdRh46lFK7/lojglh5epiYZIBlGvAp7EcyXDpdhfjDg6PPvSvTi7hzfnRP6+OLuAXwlpYpu2HdndIZALTHWFsCMCFESUCWgGvsrcG6lsgCMNxoaE0UX2mgJnMRFzoYUZf0qMIOi/dWFMiu7lP2JasiuoOhEJcnKG9EEOOtSHaoyLY2z7t3qicGE6+ZWOYLot4u8r6WWTQ69AK+lPRBEIGmq4G4KdgyoI2O0VpgvtdwDmUZZGzcn7KZ33KSVEoaByA+TM2KLgJJIOkEyUrzLTFoGh373iGc3Ml5QLTiKUziJYwb4SWwQzYGONEn0qfMlHMuCMUlwLHE9p2mccqOlVydx81MtpBgj/jqXqG3UEaKsMKkZZ9uBXG+FRWY/RIGlZMxiOZXVTU2bTKxGUNn/lSBN7Gdje2u7HdZ9ru/Mdzs0GkmPrUF1Ofq5CnwN+YgudC6hMLvUuQ2UY6p9eC3GG491Bz55fPl2DYXwVV980E5hvmRzqULyDfz+Sh3w/tri8b+nNZIIK3+azEB08kvB7hnWNMjNKsai6Olm+7XEwRwWvGeuMlsCxOQ8pnudphXiRU+CZhY36r9yIqpT2g3olYybYibjLJTSa5iUabaPR9RKNNJrmx3Y3t/jVtd20mmWFF1mLyJJVOJjyeaU0z32m1gI6r2K3KLDO5bPt8MVtxSkdbnHLm4Awb9WHd77ii5fGWt9fs+g13r8HbnXqnPmw1Ok4x1l/ndpwZWdmmCvLWciQW43o75HFpCMqlkijyyuU/2l/ko1ujlUibNwPPq7oOaXLH1pL1kygB2gAw5I7xivLi1fmJXq82C52x2WmCabZmnV5xwZSSTu7QQa9N6rhJHTfhZxN+vpvws0kdN7a7sd2/pu2+KHVsPZU6tl6QOrYYplg+plj/ydTRkx6lZj4IBWhwU2BvmOTHUk310Zi9OZxqE71SFtnoLtldGEXsIw9nNllSpUpkmLML3VtE26Jnhb0rIWA0AhcZ4tFdCdktahUenoKcFA9TBXIiyY6RIIAbzyp9Hw8iaJux+paNIkM3SAFDcgq4TQXHveMysVtbAALVQUfgqL9hjdNI6w/Vg9k5UnyCFLOje1cItPms/ttetksA9xPE6C4utKxXbBfQNXMewjRC3E+1+8pS0E2qvknVN+F+E+6/j3C/SdU3trux3b+m7b4gVTfZ0OpUHRo8O1WHttUay3KpD7R1+8/O2Pv66CNhQOrNIpdydS/PwYEJSsBLiduKYZArSPEPtCr3U7yh5tqRXtgzZ7QqeEarwr2JDHv6pCB6o/nvhR3TttUN7l6dCNDZ7FYwx96B4+yu6q12H6T36CCKmItqNqRxAH3s5UAPoB2gFY9VPpVVe2o9jO6qbjTZvW0u8XX66BLqKXhLz5xO6p8dm8lNlWQaS9rkTzZBA2gJ2xsDstMka+Hbs24zmPcwDWYHtzwbFabXdF43nNmbMsw1NXM0Am1XcfD4FD2/NtfRoYGsoGMZ+9aOBe0ZYDlHnqO3KVuNusBEX4++oFd58MIlhsbCYKfYrMHeCx7jAVvadbP1y+fLbTbC9JbcS6owsxYS5yN4yxuoCLnPvt2Bgp0ootmDFoL1S3t80FyZHwDBbBBeCMGujw0TPkFcOYdAQCzFToJ8D/bKr6byxK0IMORWc06i4oFJ7AKHdnmp3zaFV5qHyFAfXsADAXhXhT7KiCpPbQyJNK1k11NLFy/Q9Vok/sdCq2hoFYKmtuew0Ky9dvWecRd8BoLggSJuvXpwDa9SgIeTNniDUOdxQE4YPMo7s1wrtVfjUYJXQXhlPAbhZzqoV+7GtAdjCkJv4LFj5o6jSImfGEPVQTO4HqVgRa9Gi04HVsgiKo1aAaWKHrIiK5CJEn4nYBihViY+xEyAEqFI12TIJL+QZMHmv9Ahmy8lmun1NQRsbOlFrno1zjhgBQesaB+gDP46HqJigW0jDeQHtAIc5PInT2AQLfg8DWupVyfwu9QHQ4MLqOrTqtOefujlDs78YvQBW2dtwAVjIp/tVaMz+BoWBsUSs2wJYp6Di/gGEcTiOb5pfLOFVIzP/230IsX9vFKDFwZ8ay+9wpP89/jd/5DH23ia79HTmNQaK57n+T2tR9/9tX14fa4fEafNtKto1zpBXSyVKrrZDP7CV3JONG2BSaG+vxfTtiIYvBQCzZjcmDuWgoosU8HpXN0OmlI0IdcDGT76O7ypBQGN6P42vA+Bw7SYrsipss+CrhhIY5zB4uZmgPpbZKayF6BYdOsmO7S6CjnjZJKGeDkWIJFOGAeLeEKhPancVPtdmNCGwlIWUeaa9bJOCC0FWUFnRUU8Uae+OfFX0NsnxgK1VaYUD4xEiZjrJnJCzkWQ3UdZnnE8BRuMpTIWwRTn0BA0IH8UhRE+Hl8uQARgoVn/wUtcTSe1i23xqlF95QN0aFZh5kwXpEYqgdljAe7KCwHNrdB0A/C8dj3kqxHf7PZoExNxMrM7xaIf4pvqyZWe0147K+e00L8nPTzlOgYKsenDA5aIcIb3iK9hGKw/XN/kEzia+JqT5152BHwlnVvn5sbJbfbCO6uXUmaLnuEsr3c4jj18DLTQrSW6jkWY6g9m4aRyqW+3tB3X3biMc1/dWZfJ1nRzShUFK/qhuQ17osswMb+Dl/i354CzQqSjqZYCNKL3D44takIbDdjmf8vSH/MDpAPN/h/o10/9
sidebar_class_name: "patch api-method"
info_path: docs/api/v3/identitynow-v-3-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 'Service Desk Integration Update PATCH' (patch-service-desk-integration)"
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>Service Desk Integration Update PATCH</h1>
<MethodEndpoint method={"patch"} path={"/service-desk-integrations/{id}"}></MethodEndpoint>
Update an existing ServiceDeskIntegration by ID with a PATCH request.
## 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={{"name":"id","in":"path","description":"ID of the Service Desk integration to update","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"anId"}}}></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><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
Only `replace` operations are accepted by this endpoint.
A 403 Forbidden Error indicates that you attempted to PATCH a operation that is not allowed.
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>operations</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Operations to be applied
</div><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`, `test`]"} schema={{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"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"}>oneOf</span><SchemaTabs><TabItem label={"string"} value={"0-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
string
</div></TabItem><TabItem label={"integer"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
integer
</div></TabItem><TabItem label={"array"} 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></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
ServiceDeskIntegrationDto as updated
</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={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the Service Desk integration","example":"62945a496ef440189b1f03e3623411c8"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Service Desk integration's name. The name must be unique.","type":"string","example":"Service Desk Integration Name"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date and time the Service Desk integration was created","example":"2024-01-17T18:45:25.994Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date and time the Service Desk integration was last modified","example":"2024-02-18T18:45:25.994Z"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Service Desk integration's description.","type":"string","example":"A very nice Service Desk integration"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Service Desk integration types:\n\n- ServiceNowSDIM\n- ServiceNow\n","type":"string","default":"ServiceNowSDIM","example":"ServiceNowSDIM"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>ownerRef</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Owner's identity.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"Owner's DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's identity ID.","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's display name.","example":"Support"}}></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"}>clusterRef</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Source cluster.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`CLUSTER`]"} schema={{"type":"string","description":"Source cluster DTO type.","enum":["CLUSTER"],"example":"CLUSTER"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source cluster ID.","example":"2c9180847a7fccdd017aa5896f9f4f6f"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source cluster display name.","example":"Training VA"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"cluster"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility).","type":"string","example":"xyzzy999","deprecated":true,"nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"managedSources"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility).","type":"array","deprecated":true,"example":["2c9180835d191a86015d28455b4a2329","2c5680835d191a85765d28455b4a9823"],"items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>provisioningConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The 'provisioningConfig' property specifies the configuration used to provision integrations.
</div><SchemaItem collapsible={false} name={"universalManager"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.","type":"boolean","readOnly":true,"default":false,"example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>managedResourceRefs</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
References to sources for the Service Desk integration template. May only be specified if universalManager is false.
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SOURCE`]"} schema={{"type":"string","description":"DTO type of source for service desk integration template.","enum":["SOURCE"],"example":"SOURCE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of source for service desk integration template.","example":"2c9180835d191a86015d28455b4b232a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable name of source for service desk integration template.","example":"HR Active Directory"}}></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"}>planInitializerScript</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"}}>
This is a reference to a plan initializer script.
</div><SchemaItem collapsible={false} name={"source"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"This is a Rule that allows provisioning instruction changes.","type":"string","example":"<?xml version='1.0' encoding='UTF-8'?>\\r\\n<!DOCTYPE Rule PUBLIC \\\"sailpoint.dtd\\\" \\\"sailpoint.dtd\\\">\\r\\n<Rule name=\\\"Example Rule\\\" type=\\\"BeforeProvisioning\\\">\\r\\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\\r\\n <Source><![CDATA[\\r\\nimport sailpoint.object.*;\\r\\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\\r\\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\\r\\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\\r\\nimport sailpoint.object.ProvisioningPlan;\\r\\nimport sailpoint.object.ProvisioningPlan.Operation;\\r\\n\\r\\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\\r\\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\\r\\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\\r\\n }\\r\\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\\r\\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\\r\\n }\\r\\n}\\r\\n\\r\\n ]]></Source>\n"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"noProvisioningRequests"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.","type":"boolean","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"provisioningRequestExpiration"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"description":"When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.","type":"integer","format":"int32","example":7}}></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"}>attributes</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Service Desk integration's attributes. Validation constraints enforced by the implementation.
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"description":"Service Desk integration's attributes. Validation constraints enforced by the implementation.","type":"object","example":{"property":"value","key":"value"},"additionalProperties":true}} collapsible={false} discriminator={false}></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"}>beforeProvisioningRule</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Before Provisioning Rule.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`RULE`]"} schema={{"type":"string","description":"Before Provisioning Rule DTO type.","enum":["RULE"],"example":"RULE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Before Provisioning Rule ID.","example":"048eb3d55c5a4758bd07dccb87741c78"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Rule display name.","example":"Before Provisioning Airtable Rule"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"62945a496ef440189b1f03e3623411c8\",\n \"name\": \"Service Desk Integration Name\",\n \"created\": \"2024-01-17T18:45:25.994Z\",\n \"modified\": \"2024-02-18T18:45:25.994Z\",\n \"description\": \"A very nice Service Desk integration\",\n \"type\": \"ServiceNowSDIM\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Support\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"2c9180847a7fccdd017aa5896f9f4f6f\",\n \"name\": \"Training VA\"\n },\n \"provisioningConfig\": {\n \"universalManager\": true,\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180855d191c59015d291ceb051111\",\n \"name\": \"My Source 1\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180855d191c59015d291ceb052222\",\n \"name\": \"My Source 2\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"<?xml version='1.0' encoding='UTF-8'?>\\\\r\\\\n<!DOCTYPE Rule PUBLIC \\\\\\\"sailpoint.dtd\\\\\\\" \\\\\\\"sailpoint.dtd\\\\\\\">\\\\r\\\\n<Rule name=\\\\\\\"Example Rule\\\\\\\" type=\\\\\\\"BeforeProvisioning\\\\\\\">\\\\r\\\\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\\\\r\\\\n <Source><![CDATA[\\\\r\\\\nimport sailpoint.object.*;\\\\r\\\\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\\\\r\\\\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\\\\r\\\\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\\\\r\\\\nimport sailpoint.object.ProvisioningPlan;\\\\r\\\\nimport sailpoint.object.ProvisioningPlan.Operation;\\\\r\\\\n\\\\r\\\\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\\\\r\\\\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\\\\r\\\\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\\\\r\\\\n }\\\\r\\\\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\\\\r\\\\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\\\\r\\\\n }\\\\r\\\\n}\\\\r\\\\n\\\\r\\\\n ]]></Source>\\n\"\n },\n \"noProvisioningRequests\": true,\n \"provisioningRequestExpiration\": 7\n },\n \"attributes\": {\n \"property\": \"value\",\n \"key\": \"value\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"048eb3d55c5a4758bd07dccb87741c78\",\n \"name\": \"Before Provisioning Airtable Rule\"\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
Client Error - Returned if the request body is invalid.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><p> An example of a 403 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"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"}><p> An example of a 404 response object</p><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"}><p> An example of a 500 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
Reference in New Issue View Git Blame Copy Permalink