mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
155 lines
60 KiB
Plaintext
155 lines
60 KiB
Plaintext
---
|
|
id: put-service-desk-integration
|
|
sidebar_label: Update a Service Desk integration
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXXtTIzcS/yrK3B8LW9jYxsbY2STlBfZCil04A9lKwVZFnpHtyY41c/MAHIrvft0taR722Biylcfe5K4SPJZa/VL3T62R/GDFfBJZ/WvrQoS3ri3YkYg+sxMZi0nIY9eX1qcdyxGRHboBfexbV4HDY8G4ZOLejWJXTlihs5t1ZqM5Ozlid248ZQl1c9gt9xIBjdhPF2cf2NgPZ4xHLJ4KFor/JiKK2ch35nXGBiz2Pwupep+FEzZwZtDND4vDqac8iad+6MZz5kZEyA1hrNhn3LZFhPThuZBO4AN7dWvH8gOheDxxQKYgiTVRpJkXf8cKeMhnIhYh6unBkvABergOfOWiPgIeT61FJYHU/pikWqkbYE7pBDobjq1+HCZix4riuYejRO4s8LCBuA8834FHY+5F2MCeihm3+g9WPA+oZRyCJaglpz59i6Nsj4+fFHnQ7FtQLHYpsnoJTEaBsN2xa0eG61WM2j58IWOkwoPAc21qsvtbhKQecmxxzzsbk8I0g/7oN2HHS4papZ5XUcoUfa4XtHStzFAktqOG2rF4DMoYJbGI0HuDEG0du/Cpb8y3qIM1XGCHOkMl4V9slqCHCpZIF3RaN4OWGmDVnGIfkInHBVU8g6dcw/UcDNitCOdMIp1V9JARRWFTDhg2j/o38kbWDNkP/t3F0cn74pMbWcKdI8Y88eKMvu5apjrzFbDo30kRDsX4Oc51hn1AX64DPgvBAZVVdAcj+DKTZXSOLs9IdqQjZDJDRzw5Ov5weXL5C7paxn/6FDiHULHxCIZTCJv1gkJadq950ODt/THnjhDtRnN/PGqLRvPAbjX293o4kPHtzYZy3Cjw+Fw5eFH5SRD4YQyxA6znxvSMeh3FvvX4CZ7aHkyDZ5vjwk9CcCfd+aXGKFIptcnh6dXF5fGwaBLzcEOLLAxTbo+Ddpd3x7btOI1ml/POQW9/3Bu3x/vjze2xMNBqs1yG3JWYbn8eFEyjCByq/osmWp7Vh6lEmH3X56itUAAzNqRSyOSZ0XcgxcbADDxHEiNuf77jocNsfwbZ0B25Hrjw9vrQdD///fd5r9cjfQShsBEdqPwH3M+45BPhKNGiktCklHZyFD1TCPC4WzeCx8DPoS/H7qRuxhqKiKiCgNEOg/yRSTkVodhQVB6GfI7YIBazaNn6j8vi5rRybfxqr+M0e01+sN9odpzWQbvTGbV5a6+F6mrZnf1ck053P2vSO2jtWWj+ZTnLM/+r5YavmJ6Wc5OChQJoNn2daLUmkUJYKYG80qOcRtJoUJztkEEhOUXce0/6L/HUi3T0u6kABkIF44pswAPDiTJkwcQGVCo3gUDFlI3hc+jPSCo/nADaPAHcg7Zg0tBx8v7AODgAdPfvhJMTbeT7nuCSsAl3zqQ3NyZNs5wGbKmJiw6eH2NZAfAUHE8iuyBeyvlTDg+eBw4fA2xh7yGS+MAWQhZjTIe5Y7aofdQjsbrOlZ8Z6MeLWL2UyRemARP3EbFG2XiRHs9ZN57JExdnV8PD42Ka0M82zBIK5z97/MU0UjbdRzDd+eZp5McEXKqGbshHngarf4i1H4dsYMfgJewIQLcd++G8mHayBZOyt/W4hLbLcSXGHWM65UHgnmqyan93nmmkVYsvJX2ZxiGE2p1WzwaNw182h7zdsJt7zb28xtdqOJ+o14z3fs6MelB7WahPDaqFUbKk/JFH2J0eeQT8JUaNThP+sQx7GWXWBKZfQK4F/5SRaykEAdLJE+nGLvfc30V4QaoosyaEDvg/z8xHC2+G/cHPUgJM9Xo6M2gtrhlpmIAB4imPVUyOijHflTBHEpt8255yORHReizy5of7mYdLJaTw3atmvfGKgRy+Aw2/e3V1+a528OqH729uwpsb+eabo7PDy1/OjxUT51dvT08O2c3NjRVx11P1BSd28EH5U0OHuqPuv8Onx4oZIkp9kVv65q2AySvOcwLmqDD25ijT0feqLcs3VmzeTV17apSBrosuDJqUDgiq/iabzUDm8bz+ZjdPNR1K+cf3b765PjwaXA6u1RfuDFcLLBNUmbX++tv13+e5PAdfqQ9s209kPFQp+4/1rp+ZAs+z6Zjqwcv4eO5wi3yqf2O83mJFkbCWlf/YpxlWn4i42C7a2mbb7MFYDZL91kJX7HMWbG3X4SPk/C22zBVxm/JWP1IewwqU2SLZiMg+Te09eRnb/tZQevyizB7LP4HXx7y5GPv06fs3u3p+3EgV66Wfp26ssxzXPugMAuEyLV2p6Aa4VxIuzaYspRl+izMbupQMoFMqgWYpIKiRmygEGwkZA4XQTyZTBaZzOKAU1z6FY4NlBo7vA1eXlpZE/YgCafYDIZ0CRKcSLUrp7CjmYHBYfimZAQ2MQBaQeQpaLlaMMScobI5RzEPMMlKR0KUvYcUQuY7AkrBA5uC/GPkA6nu+RPDLx2NSGaUsXNq53qJKSFGwStmxsGbNY/Vor5VPJN08PjpfXoE9FmqTz6n4Zd3q7GdIp45CbihYjGWBGFUHjOlVLpVwkacZGHxRkjTrcsdx8Tvunefy78KS9MEkZ1jaWFS8h56fRfYJZR4t5SjMOs9ZMqzKXC9dHqzMhGX1ouHV6QLApCcbrgFWDrVYM2q0D8Roz+l07A5vdzsHI6fRdWx7dNDttpt292BzsE/kV1eKyjgauGFMYZEsk3fUZYCBTXQhifYPSiB/rpxNLZFgcReDHkQBeKiyW6vRWOnyyxRxU0hvGVXbDtW2Q7XtUG07VNsO1bZDte1QbTtU2w7VtkO17VBtO1TbDtW2Q7XtUG07VNsO1bZDte1QbTtU2w7VtkO17fD/tu0AFNtlOwuHnotR5zgMIafV2FDESSjVInTxsAmjgHSL/l1/zmbDejjpYBXHO6RTG08p9h3Em9okVFUfQSwDDNQ1BYpWM9SsImlQP7UrWgA0UW+yt9xhJiofamFQ8SG3PwOtkw2c64r2GZjpwlwnXf+XDCu6go/2G71We7zf5hxWks1uZ9Qb8729Rq/ToyrxTEQRrPjztSmz0C8O/W9IH6FrQ4y0CcA7YCsOuicGaPCSMtcKGxCNDfSPS0PVNhVT8wur1Pt4ByDq28Nz1u4yiNSThJ7zyYISZO3qAtc1ieehx6e5ShE+C92JK0tP7OhwcHT8bnB1eglPhsf/uTq+gL+Q1tIBrAEubxx0S18npjviWAtwxyNIuB6oQzh19lpTfQ0CYTrONXR1Vp9HoEymMy700KOX9MiTzipZZirRvLmP2ZZbF/UdSIXwDDIWLABGHEtluOSH5q8BNoogrp1qTb5mU1jbinC7zgZpZlDHxCLoTzUkSBk4dRWBcQJTWdC5MD+JIZ3GEByKtshUWbRGFlNO80bByQGcP+0nAzsGMEg+UZiFqbdoFrV9gGeluYWKek5ppNI5ZEtYN0JLbw5qDEOqTYBsbhwxHY7QXBEEHmnapRErH1Qp3L1XzKgACfGMJ9EG8w5gqCtrJFr6xa3Qky9KS64OWcOYSUck+BLFps66VWouM/HZ2BWeU83dau5Wc3fDubv45VC/T5GHPs1l6HMl9XFYTJ5L0Cck74FFiGmkML0y5A6er9UQ6aePl/oILq6Q1ALmC+IjlcqXmB+k9lDPRwg/UmMVbIEM3markjFEIuH0ie+MY1KUUtXe8mjv/HDkgoPKEogIUTNkcz+hJWyYSMKzPNphji8i+SpmUw7x0Rww9tMzxrX0kHGFJCskWWWjKht9HdmoQpLV3K3m7j9z7q5FkilXNFs0ToqS2YyHc+Vp+nvaLWDQgJk3e1k65VRVdgGtIDGWYiyriBysUas5ao67tmg7vO3s7/XGLXu/xTvdZrc5are6Vj7XX2fzOJ1kxTmVs7eyo7raRIS4GZFIcK4o9n2nWP6j163GGNZoJ9LgZtB5XdUhNXZsl+yf+DHIBoQBO4YryotXw1O1P603OkP94g3CbP0OAu24IKREH1Z36lTQsYKOVfqp0s9Xk34q6FjN3Wru/jPn7rOgY/sp6Nh+BnRsM4RYY4RYfyV0dFyHoNkYjAIy2AmoVyJsDEAU86JDOu1jHk5EnAK9Aops9UreLvR99p7LuQFLUaESKTN1YXjz6S3xee7dFQkcTSBESgZRywV0i17lzgRiUrym0XNnLs1jFAjohvPaYIznMNScMf6WjuJK20uAQwoK+JoKjnvH3di82gIUqA46gUD9BWuc2lp/qB7MhijxKUrMju9tIXDOp/XfTtlbAvg+QYjh4kLZesXrAqpmziUsI8R9oMJXCkErqF5B9SrdV+n+60j3FVSv5m41d/+Zc/cZUF2jodVQHRpsDNWhbb3BUiz1jl7d/rMR+0CdBCUOyL2ZbxNWdzIMDkqIBDx08bViGOQKIP6hcuVBEk9xZrqO7OsjazU8slbjeMF4Xx2cxGi0+H3ujWnT6hO+vToT4LP6cnEMVnhNeN/aXdU32n1wnUcLGUQkqpSQhB70mcZxEPV3dx/AN8AnHus8cOvmyL707+q2P9sdgUFKYp06uoR+ig3Y4PxEL2vqZM3Qpdf7aTYQcWVbc1VCeo5kLWVzFG0OKx6myOzgy87aeekxHVyWc3OzBTnrknwg11XoPf5xWRShFbKUqW/taNCeAacLIlrqJWXjTxcI89XoS16VpS7cYGgtDXaGzVrsreAhnjamd262fvp4uc0mCG4puCQR4mrh4moEpuc5uAgFz4F5/wQ7UT4zxywEGxTe8MHJysYeCMxu5IUQ7PpEK+EDZJUhpAFSKXYSFHmw16ctYx1H3AoPE2490yQ6HkyIXdDQLi/026bkSqsQV6qjC3gcAC/qUOc60eWpjRaRFpXsOjBy8ZxcL2XiX4ZaTVGrEbVoe4ELpdprW70xbkPEQBLci0hbLx5c0avl6OGSDZ4g1UUeUBOaj+J7Wbax2ov5KNCrIb0iHzfyIx3TK3ZjKn6xCBKv57ATZk99PxI/MIaug9PgepLALHoxW3Q2sEYzotZq5FiqqSFrbg1wKPF3ChNDKmfiI8QBBIN8VZGhKfkrWRbm/K90xObXgsz0+Bp/OwJaOr4dvZhnHLCGA9ZUDIg0/yobomPB3EYZKA4oBzjM7E+RQDOai3uKVmlUJ/K71AdTgw2sqrOqQV996GcBTv/F6AtsnbaBMIwwPn1TjS4kULQwJRaUZQoQixpc5tfzIRMv6E3xm26jYnb+u8mLEg+yOg3envClo/SKSPL3ibt/UcSrIs3XGGk0sMZ65zD7oZnj7CSfPum//l6ypeXXJneIpYcLl+70yt/bpdukl2MV7ihYc7dVekdBejPV4hVUmrK546l4+cHqS5pSwoW7lVbdnlN6Z8vf/B6HNdc4mGsWqusPqusPqusPqusPvuT1B6svP1AVwSeuDegunZR/6hD6ujPoOqDSmW4dTp88ip2G083OUiPEo6F01S8PLN/qGsnyXh1uJk8F/Bu+pQhEdTNux+q39rBykCeElzTR7/TRz+lNXUFV/kBwYmYH0Zw/I/QL2kLIjTenIaFJCG3oAh7ucXVlHe1Dm5E5gVRVzMGYSFdFJPqtSF/HzTr7KCgtJCEWXfE8Dnz3m6+rrxcw1c9xqgM40ACLHfqzWSLxOktgO5kxDjDuCRQGsdlO1GLB9qUURhc+lVvSXgY5I7xDEeh6AxHOorOxRiA5sPXEWIC1Ir17DKrP4aRMkKFQ90Fgu2Kp7CnagPBqU+EF6KGw0hEyyiOx9yeXSxSBmNSvLPjhZFd3inaxLRDRaRo67NUhU9eoRIeQxY9iACg54ub3IdehtoUbaNMd9K/kxyX1zMcC4G6A22SoqUQVJFUd+NpaWQeG/n0IFgChpqBbbPrwgJsqWBl9xMcgCFbsrz9lRU/CgxpfOOmlKSu1vDXUQmyzZ/5QZalkZptQzrMdAiuNlCAL3euldn6IU/WFftWgdqmuTzYdl96hQHCqeqjdpLVt84X38yt085H+1cuZ2qsI+R08xH/3rRv4H64VAqV4aETPHyyz8wdtFFlTJimrEug/wCDQ7H/r+v9q
|
|
sidebar_class_name: "put api-method"
|
|
info_path: docs/api/beta/identitynow-beta-api
|
|
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a Service Desk integration' (put-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"}>Update a Service Desk integration</h1>
|
|
|
|
<MethodEndpoint method={"put"} path={"/service-desk-integrations/{id}"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Update an existing Service Desk integration by ID with updated value in JSON form as the request body. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
|
|
## 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"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
|
|
|
The specifics of the integration to update
|
|
|
|
</div></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={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></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> |