mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
156 lines
53 KiB
Plaintext
156 lines
53 KiB
Plaintext
---
|
|
id: patch-service-desk-integration
|
|
sidebar_label: Service Desk Integration Update PATCH
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztPP1T4ziy/4rW74eBecQkISGEm92tDDC3bDEDL8BNXSVTNYqtJNpx7JxlA1mK//11tyR/5IvATt3dbmXuinVsqdXf3Wp9PDrRVMQ8kVF47jvHzpQn3vhaxHfSE6dCfTsPEzHS3509J+Ej5Rz3HNOAYQtWbPJlz/GF8mI5pZ/Hzu3U54lgPGTiQapEhiO2HDobzNj5KbuXyZhxdtW5OfmFxeJfqVCJCyNPecwnIhExjv/ohPADoEsfPslQ4z125gcHeNGQJWPBSgjLwqhJxFJCETrjcDIWwIYkTsWeo5JZgKMoOZkG2EA8TIPIh1dDHihs4I3FhDvHj04ym1LLJAYKqSWnPscOR74+PX3R4IGa95E/wy7zo5VR77AA2IXoX5+efzQ4skxWinHPi2If+QkkIIm9X68vP7ErlN+XnXGSTNXx/n4SRYFypUiGbhSP9sfJJNiPh95hu1rfZSrhoc9j3+2H/fAyDGbsayymAffE19JIscDRxDQRPkopGUvFROhPI2Ak9e2wRvWAfYjigfR9EbKzOI5iYLMvPcBaQQ+esFmUMp4kYkJwAGktY54PpdsB8DBKGA+C6F4gbsBOLwKRhQmyjU+nAYKF9vu/qSiskMb+Lz7i5wWRRIPfhJcsqEaHIbuIW8yPvHQC4BlXzBdDGWo6e90PJww5xSrspbx1GXstQ1HZY2ydSKGQkLwn/iqTcZlDBY4OAC6yR6BZGPp5HPMZWglwXr2MLxnw78iYkpn1gDaybbDdL4tkLzOsMrY3Y1FUH+IA/BxG8YR4IMJ0gsNw36eBJ9GdNnQSCjyZF140RR6BriaISG69tuWTwfJZjDpMfzCMQYmKGBzZNBYKVIzsFZBOeDwSCUOYiDa6x0CQDhoxDocgHaseBSJLvmW/ODageMeDVBDvQnE5JEe52jF9Eves2B/Il0lQaPy0l3UnjyniYv+DajXvYb8XumT6ZdtkLzIQYMwJDDVIEy1x49SnYxnIKfjMAjSrxRaY/v20EG5QIYgLho+pAh6COpSZuMesDtK3PupH3wEp+PBsRA6/C4a3jnGAZ4bXr+CGyBoy20E6norde/2QsUf8g//6oOd957g47l7+DfVDf92P7kMRd8Ww9J1IxQYZPP1e+rpX3WvXjqpHhy2/2hzU661qDZ7a7XqN1+FFwy8A0x2R3brr+enZp5vzm38uNEEp6SadcCSCqM7QbETcd2y7J3yAP19IhkCYmgIPtYzr1eqiF1ueEZyiYSgT+vz1UaDs+iF2lNV/hbNblRW8UUxNhSeHZgh3zmuRopaBGX+7V1TpBZemFXwF9cuwwA4uQ6XGJzZJISVArQ4lpBJu7uSXmPeqFI19QiSe5ljxApwKDddj0GF3Ip6xEOGsgoeIaAibYsCwuTrGtKNiwX6K7jFLKr/ph0uwgyjG0yDJ4Zuuy1hnPwGK1vheolyX2Af4JX30+8lsMbBbwtdHFAvn9OaSaHcLcc0aaTloZW8Bc8iQNx7BYgp5uFtiiHYjvHE45NwXolGtHQ4HDVGtHXn16uFBGweyur3ZUL5U4O1mWsHLzE+n0yhOSl6VeoE7AIcPb70gRX/zQnFcR2kM6mQ6v1YYZShLZXJycXt9c9Yti8S+3FAic8Msl8dRo8VbQ8/zfXDrnDeP2ofD9rAxPBxuLo+5gVaL5SbmMsTs5R+dkmg0gBPdf15Ei1Z9klGUReWVhr5jIiIlQbnQMXgnnHJRBDHg3rd7mMQwL5pAuJQDSB6S2e561/Qw+/33WbvdJn5AauZRhKGJGGA/4SEfCV+TtiTpNkw7P1UvJAI07k4qeA34nEThUI5cO1ZXKIIKBKo9BvEjp3IsYL6wGamrkv0so1sgt8CVntWrg6Zfa9f40WG11vTrR40mpAq8flBHdtW95mGhSbN1mDdpH9UPHBT/Ip2LTMSg9max4RtmzHJmQzDNH0FF6XNq2Ep5HeQHGYAi01WBI5k3KFs7RFAITooHH4n/SzT1Ohv9fiwAgVhP08powAuLiRZkScS2fqHVBBwV0zKG33E00SlpPIKp4vmQkSxg4mvg+EV90BNGMx/OSRvANEvwkHIT7uN0My8lmChn6hSZiMsKXhxjkQHwFhQvRHSBvAzz5xQeJ/gB6BeQ9RE8SYSzYEhZrDB9JodsnvvIR0J1nSq/0NEjos8j+cowYP0+1mdUPp4y4/nrxrNx4vrytntyVg4T5t2GUUKXt148/nwYWWbuAzB3vnkY+SUFlaqgGvJBYJLVP4TaL13W8RLQEnYKSbeXRPGsHHbyGYOWN80Fl4ty0e9Y0WkNAvXUxmr03X+hkFbVHDX1yzgOLtRr1tsecByePA5xu+rVDmoHRY6v5XAxUK8Z7+OMWfaUJqG5ERliNC0ZfqQRXrNNGgFPYlBt1uCfY9HLIbNacda/Obg6/FsGrq4zCKAuPA9lInkgfxfxNbFimTTBdcD/eS4+qqcw7A96lgFgutfzkcFwcc1I3RQEQKVK8smq7PNlCDaSeqTb3pjDFFmtz0Xe/fwwCXCqhBB+fFNzq28Y0BFhbffHN7c3HypHb37+qd+P+/3w3Q+nlyc3/7w600hc3b6/OD9h/X7fUVwGun7oJz6+WP7WwqHuyPsf8e2ZRoaAUl/Elr68F2C84qpAYAEKY+9Ocx79pNuyYmON5v1YemPLDFRdVGFF5RYR6meS2QRoHs7cd/tFqNlQWj9+evdD7+S0c9Pp6Q9ygrMFlhOqxeq+/dv670Usr0BX3I7nRWmYdHXI/mO93az682I4tnrwOjxeOtw8nvov+usdViaJ1hsKP4/JwtyRSMrt1M4u22WPVmoQ7HfmumKfy+nOrgs/IebvsEWsCNsMN/dUawwrQWbzYBWBfR7aR9Iytvs3C+npuyJ7Fv4bcH0qiouxL19+erdv7KMfal8fRkXoVjqLfu2TiSDgLrPSlfZukPeGlJfmJkthht+hZUOXJQOYkEpJcyjAqZGa6AxWUXl7HEfpaKyT6UIesDSvfS6PnS4icPYwlaa0tEDqZyTIoD8VoV9K0WkJBqn09zRyesFD0wzZwABoAZrHwGX9zvSkmKBzc/RiAeYsA+0JJX2EGYOSvsBis0Dk4L/o+SDVD6IQk19d61c6ZOHUTgbzLMnr77i0wRP96qBeDCStYn50tTgDe9qbK7dvXPHLu7nsHxBOfZ25IWEJlgUSZB0g5uXrFbRiiusZ85RkUZf7vsRvPLgqxN+5KemjDc4wtTGrG3vON5H/QpoHCzEKo85LpgyrItdrpwcrI+GyelH39mIuwaQ3G84BVg41XzOqNo7E4MBvNr0mb7SaRwO/2vI9b3DUajVqXuto82SfwK+uFC3DqCPjhNwiSaaoqIsJBjYxhSRaNl+S8pcXCcwKS2PZysJJINHr6AXpCuuKJI1DPQkt2vAg8meMHNId6rf7ksWG9emkj1Wc4IR2DTzH2A/gbyqjWFd9BKEMaaCpKZC3miBnNUib9VO7sgSAE26Nvec+s175xBCDjI+59w1gnW+gXLe0zsBsFybztbQlw4qW4IPDarveGB42OIeZZK3VHLSH/OCg2m62qUo8EUrBjL9Ym7IT/fLQf4fwEUsPfKRHCbwPsuLAe0KABl+3pl2WAcHYgP84NdRtMzINvjBLfUj2IEV9f3LFGi0GnnqU0ns+mmNCWLm9xnlNGgSo8Vms0oAvYzmS4dIdI8YdnJ596Nxe3MCb7tn/3Z5dwxPCWljp7IR2g0VkAtM9YWwIuOcKAm5Ai8gue2ugvgWCMBwXGkoT1WcKmMlMxIUeZvQlPYqg80qWNSWym4eE7UhXuHsQCuHdhLYTDDiWymibh2BvO7QBonJhOPmWjWFuK+Jdl3WyyKCXchX0pxoShAw0XQ1gmIIpC9ovFKUJbhkB51CWRc7KsjRyn3JRFAoaB2C+wRq/l0AySDpRssJMWwyKdgOMbzg3V1EvMI1YOoNoCfNGaBnMgI1xTLUJoE0mihl3hOJS4HhC2y7zWEWnSu7uo0ZGO0jwZzxVG9gdpKEyrBBp2Yc7YYxPZSVXn6RhxWQ8ktmIRJ1Nq0xc1vDZUIrA39ru1na3truh7c5/7Jr9FMXUp7aY+tyGPAX+xhQ8F1KfWOiNdsw20jm9FuQew+17mju/fr4Bw/4maLHDTGC+Y36kQ/kC8p1MHvr9wG6csqE/lwUieJfPSobgiYR/THjnGBOjNKsOFkfLdy4upojgNWO9dxFYFqch5bNc7TE/Eip8k7Axv9Pb+ZTSHlBv5qtku/m2meQ2k9xGo200+mtEo20mubXdre3+OW13bSaZYUXWYvIklU4mPJ5pTTPfabWATnzYnb0sM7lsB3oxW3FKp0OccubgDOq1QW3Y8kTD5w3/8KA9rHuHdd5s1Vq1QaPecoqxvpfbcWZkZZsqyFvLkViM2w8gj0tDUC6VRJFfLv/RdqshujVaibR5M/Dc1XVIkzs2lqyfRAnQBoAhd4xXlBdvuxd6fdosdMZm4w2m2WYPAq24YEpJh1/orNQ2ddymjtvwsw0/f5nws00dt7a7td0/p+2+KHVsPJc6Nl6QOjYYplhDTLH+k6mjL31KzYYgFKDBS4G9YZKf7DTVR2P25nynTfRKWWS9vWR3YRSxjzyc2WRJlSqRYc4udG8R7RKfFfauhIDRCFxkiKdfJWS3qFVyIjAnxXPjgZxIsmMkCODGs0pniOcwtM1YfctGkaEXpIAhOQXcpoLj3nOZ2K0tAIHqoCNw1N+xxmmk9YfqwayLFF8gxezswRMCbT6r/zaX7RLA/QQxuotrLesV2wV0zZyHMI0QD1PtvrIUdJuqb1P1bbjfhvu/Rrjfpupb293a7p/Tdl+QqptsaHWqDg02TtWhrVtlWS71gbZu/7sz9o4+CUoYkHqzyKNc3c9zcGCCEvBS4rZiGOQWUvwTrcqdFC956TnSD4/NkbUKHlmrcH8iw2N9cBK90fz3wo5p2+oL7l6dCNDZ7GItx14j4+yv6q32H6X/5CCKmItqNqRxAH3s/TqPoB2gFU8un0rXHtoPo3vXiyb7AxDJEm+nDy+hpmID1rk6NxMbl+QZS9rgT/ZAwLV07WUJ2UmStZDtYbQZzHmYBrOH252N+tJrOroczuzdFuaWlzn6gK7bOHj647RoQCtoWca+taNBewaYzpHo6G3KVqOuMdHXoy/oVR68cImhvjDYJTars/eCx3jemHbd7Pz6+WaXjTC9JfeSKsyshcT5CF6UBipC7rNjd6BgJ4po9qCFYJ3SHh80VzYMgGDWD6+FYL1zw4RPEFe6EAiIpdhJkO/BXvntTr64EwGGXDfnJCoemMQ+cGifl/rtUnileYgM9eEFPBCAV3Xok52o8tTGkEjTStabWrp4ga7XIvE/FlpFQ6sQNLU7h4Vmbc/Te8Y98BkIggeKuPXqwTW8SgEeTtrgDUKdxwE5YfAo78zyrNRejUcJXgXhlfHoh5/poF65G9MejCkIvYHPzpk3jiIlfmYMVQfNoDdKwYpejRadDqyQRVTq1QJKFT1kRVYgEyX8LsAwQq1MfICZACVCka7JkEl+JcmCzX+lQzZfSzTT6x4EbGzpR556Nc44YAUHrGgfoAz+Oh6iYoFtIw3kB7QCnOTyJ09gEC34PQ1rqVcn8PvUB0ODB6jq06rTY/3jOHdw5onRB2ydtQE3jIl8tleNriTQsDAolphlSxDzHFzEN4ggFs/xTeObLaRifP5voxcp7uSVGrw/4Xt76RWe5L/H7/6HPN7W0/wVPY1JrbHi2c2vOj3Lz/IVL7Ls6QseC1cx2sS4fKuamWosXrqHlwSgZhOFZrpTtKf3JjVcLFJiFX0s4C98JbdAEwaYjunLZzFhKgLC2ynQgMiBeGMpqLwxFZxOtO2hEkcTMvppHKGnwStjENAohjZ08wCHCSnd1UMFeDsyJ9vUOSyqEJ2RTc12kMicl3fZZ0HXAaQxzjZxIzJ8+y0y085rUAK6ZJKdWr2C/G4ySUO8xwvQTieMg/Y+o3y+VF6qfSRMPkNheRFRlpn1sg4DtRpJoHOdIp6oy6E5nVfQsWfGAhVTpmwOrEcpmqsgckK6IsiuXyzPEJ6DDYpdGYtgivNdcPCQ64nCCB/PbxYgArDQrNXgnaWmk9rHtnizpr6eATocuDW3WqGZCZ5AjlQC070C8JX37pmbkOnW23mlfMyXD77bjckmiOHsY3+KVTrEN9WzIW1rPWflJBT6H0sfj6WOgUJs+viINR2clj3haxgGCwa9L/mMi4zaHBX3szPbK+nc6ZobFXfZC+9pXkqZrVKGs4LXcOxpYaCFPIYuPBGm+oNZ6ajc6Nsbbcd1twzjhFV31nWtNd2cUgnAin5gboCe6LpJzO/hJf49dvrwP/gRTY2bfNTvHx1bhYQ2GrBN2JblK+YBpAPN/h8K1QOU
|
|
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 '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 Markdown from "@theme/Markdown";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
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 label={undefined} id={undefined}><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={"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={"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}}></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={{"description":"The type of object being referenced","enum":["SOURCE"],"example":"SOURCE","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ID of the source","example":true,"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Human-readable display name of the source","example":true,"type":"string"}}></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></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 \"name\": \"Service Desk Integration Name\",\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"}><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> |