mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
153 lines
61 KiB
Plaintext
153 lines
61 KiB
Plaintext
---
|
|
id: create-service-desk-integration
|
|
sidebar_label: Create new Service Desk integration
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXf9T47YS/1fUvB8ObkhIQkIIvV4nB9wrHe7g8aU3fXAzVWw5Uc+R8ywbLmX439/uSnbs2AmB3rR3HbcdShxptd+0+9HKEve1iI90bf+6diHCW+kIdij0J3asIjEKeSQDVfu4VXOFdkI5pY/7tYNQ8EgwzpS4Y8u66QZjAxYFn4RidzIas9NwxAbuRCoWhPle5imPo3EQymjGpGah+F8sQ+ECAcYdR2jNojE8F8qdBlJFjdpWLZgKM9SxC0w5xJSli2SzImzVkKDQ0ZvAndX27xcEuhwLpqfCkZ50NAs8K5qcU0A+zAhAywngCxUhHT6d+tKhJtu/ayR2X9POWEw4fev7px7o9r4WzaYCBgqGvwsnqi0qNKeNzKgvdMoWfW5YQVAzaDLFJ2KB2JYZaqvGoyiUwzgSGg04DVFbkYRPwJd08aflSUM7NSrwdKUkaIxJFyQFBkTIPLBbBJpaxi2QEJ/5ZOoj1d12v9Plnf6u8DqdZmuvP2x5zR2xs9ve6bRazl7tYcuwXzDGCmVghwZDa+FvbBLriA0Fi4nVRiJ7RqQ5P8vclL1HJoAZY91SxYDgEw7mrrnQoh7JgtKNB7k0KRT4LLRYqSl2xzVLBsxy2W62O/Vmq97qXbb29jvd/Xa30e93/osMTgIX7fAXcuhz0G86bJHPdr21V+QzN+wTjJtpuNqUA3YrwhlTSGepLz4kFNblgGFzvX+jblQ9Ifs+uLs4PH6Xf3KjSrhzhcdjP5rTt13LfDD5ClgM7pQIz4X3lGBxin1AX2ZmRjNUVn56J4KvnuAJncPLU5Id6QgVTzCwHB8evb88vvwVQ8ec//QpcL5OCFnklB0fNvJu5PRbe03e2fU4d4WAOLHrDTsCwoXTbu7u9LNBYr2hXKmnPp+ZSJFXfjydBmFUe0DPkBE9o16HUVB7+IgRwId48mRzXARxCO5kOz/XGHkqpTY5OLm6uDw6z5skebimRRaGKbfHXqfHe57juG6z1eO8u9ff9fpex9v11rfHwkDLzXIZcqmAAvtlkDONIXBg+i+aqDirD1KJHk1TbCMUwIwD4GI4Y3OjbwHoiIAZeI4khtz5dMdDlznBZAodh9IHF95cHZo+z/74Y9bv90kf01A4JqVEYSxAc7Hv8yG2w88Y0bniI+EaUXVJqDJKPD7UTxQKPPBWangM/B0EypOjRjLWudBEFQTWWwzwwVzqsQjFmqLzMOQz+CgjMdFFb3goEz/V0nXiZztdt9Vv8b3dZqvrtvc63e6ww9s7bVRf2+nuZpp0e7vzJv299k4N3aEoZzm2e1Fs+ILZaTpLIJbQpGGHvo6tWmNtMGhKIKt0ndFIGh3ysx+gCSQrzf13pP8Sz71IR78bC2AgNEA3zwY8SDgxhsyZmFlwa9wEAhczNobPYTAhqYJwBHj82GNkC6YSOm7WHxgHB4DuwZ1wM6INg8AX3IBo7p4qf5aYNM16Hvd11sR5B8+OUVQAPAXHU8guiJdy/pjDg+eBw0eAB9k7iCwBsIVYMDGmy6THFrWPeiRWV7nyEwO/t7iaKWXymWkhyQO4JtHz8bQdz101XpI3Lk6vzg+O8mnDPlsza0BQfc74i2mlbLoPYbrz9dPKTzG4VB3dEAOpWQX8KdZ+OmcDJwIvYYewqHKiIJzl09B8PWnsbfLQPJalHFuVGo0mIndJZKfbJ5HhNzFsdlvwTy2RuPZuxqwntUAPzyDXhn/KyLUNqyC0OlYyktyXf4jwgrRZFiZhbsB/HIKJnY+09mbYHxSZEmCmV1noyye4RY83Rlo18nns46qERyYI6XyQkwqcInbImM6Yq5HQq5Pxqx8/T3xcKyCFH160Gs0XDOSC9Ywa/fDi6vJtfe/Fj69vbsKbG/Xqu8PTg8tfz44ME2dXb06OD9jNzU1Nc+mbkoMbufig/GlCh7qjLX7Ap0eGGSJKfZFb+uaNAG8VZxkBM1QYe3U419Fr05ZlGxs278bSGSfKQJCF2te0whPK/E42pDXcrPFqO0s1Hcr4y+tX310fHA4uB9fmCzlBuMzmghozN15+v/r7LJdn4DuNgeMEsYrOTY76c70bp0nN58l0knLI8/h46nCLfJqfGKA2WF4kLG9lP+7TjGuMRJRvpzc22Sa7T6wG2W1joSv2OZ1ubDbgIyS5DVbkirhNeWscGo9hOcpskawmso9Te0dexja/Tyg9fFFmj9RfwOtD1lyMffz4+tW2nR+w7n/A1KCCLPXEOsW49t4mJwifaS3ORDcAeoqA2HzKItTR/BZnNnQpGYAZTyOUqAQENXITA9k0LK+BQhjEo7FBj5nEVwrkHgNu0yIDR5+n0tZWCqJ+QIEs+1Oh3BwmpaotSuluGeZgcFhvGJkBowxBFpB5DFo2z2xPygkGjGIU8zFJD00klPQlQGQtXYFVYoHMwf8x8gG29QOFaI97HqmMUhiuZaS/qBJSFMDyTAkNHu20s4mklwUEZ8Ulx0Ou2PqUkte8W4P9AunVNVAFBYtwXRyh6oAxu6xD5UjkaQIGX5QkzcLcdSV+x/2zTP5dWIPdJ8kZsHztlvsxFgw/ifknlHlYyFGYdZ6CkZdlrufi4aWZsKxgcn51sgB76cmaoHfpUItFk2ZnTwx33G7X6fJOr7s3dJs913GGe71ep+X09tZHt0R+eamkjKOBDCMKi2SZrKMWAQY2sZWUh4ePpRg3UxinlkhwvuFgg0Mo9BQ81Nit3WwWXd7FkoJPOym0pDaV7oW9gmoXpdpFqXZRql2Uahel2kWpdlGqXZRqF6XaRal2UapdlGoXpdpFqXZRql2Uahel2kWpdlGqXZRqF6XaRal2UapdlG95FwUodso2Sg58iVHnKAwhp9XZuYjiUJlVV3YODwOXTsVIdYv+3XjK7snqlbXZqTkI3DUU+xbiTX0UmjKHIJYBBtpFNEWrCWrWkEz2fqhd3gKgiUaLveEuS6LygRUGFR9y5xPQOl5/cyXpwqSbLnhLhhU9wYe7zX674+12OIelU6vXHfY9vrPT7Hf7VCadCK1hiZstxiQr2/zQ/4b0EUoHYqRDgN4FW3HQPTFAg5fUdZbYgGisoX+swZi2qZiWX1iWfY62AKK+OThjnR6DSD2K6TkfLShB1a8uCosMkNwQPg3lSKoyVpJwcHj0dnB1cglPzo/+c3V0Ab8hrcIZsQEud1x0y8Ampjvi2AqAGyNa+KAO4TbYS0v1JQiE6TjTUNqsPtOgTGYzLvSwo5f0yJKel26SqUTz5nPENmRDNLYgFeLmDI9gATDkWBvCNS40fwmwUUyj+onV5Es2huWyCDcbbJBmBkZBXkN/KppAyqBNTiLgxTCVBZ18C+II0mkEwSFvi7kqF5d8SUw5yRoFJwdw/rifwFIcwCD5RG4Wpt5iWbT2AZ6N5hZKyhmlkUpnkC1h3Qgt/RmoMcSFPpU+ZaSZDUdoLg2BRyXt0oiVDaoU7t4ZZkyAhHjGY73GvAMYKlWdREu/uBV28um0xuiSNRIz2YgEX6LY1Nm2Ss2VTHzmSeG71dyt5m41d9ecu4tfntvXQ7LQp1WEPlfKHvjF5FmAPiF5DyxCkkYG0xtDbuEJYguRfv5waQ8Z4wrJLGC+ID4yqbzA/CC1h3k+RPiRGitnC2Twdr4q8SASCXef+J5zTIoyqtopjvY2CIcSHFSVQESImiGbBTEtYcNYEZ7leou5gdDqRcTGHOJjcoQ6SE9R19Nj1BWSrJBklY2qbPTPyEYVkqzmbjV3v825uxJJplzRbLE4SceTCQ9nxtPs9+b+FmjAkheVWTrlTFV2Aa0gMZZirFoeOdSG7daw5fUc0XF5x93d6XttZ7fNu71WrzXstHu1bK6/ns/jdJLl51TG3saO5vIZEeJmRKzAuXQUBG6+/EfvF3kY1mgnMsHNoPOGqUNa7Ngp2T8JIpANCAN2DJeUF6/OT8x+td3oDO2bJgizjerMjgtCSvRh0LTUUQUdK+hYpZ8q/fxj0k8FHau5W83db3PuPgk6dh6Djp0nQMcOQ4jlIcT6O6GjK12CZh4YBWRwYlCvQtg4BVGSFx3SaR/xcCSiFOjlUGS7X/J2YRCwd1zNErCkc5VINVcXhreAXoueZd5dUcDRCEKkYhC1JKBb9Co8PAWYFA9T+XIiaR6jQEA3nNUHHh5EMHMm8bd0FKkcPwYOKSjgayo47h2XUfJqC1CgOugIAvUXrHFaa/2pejA7R4lPUGJ29NkRAud8Wv/tlr0lgO8ThBguLoytl7wuYGrmXMEyQnyemvCVQtAKqldQvUr3Vbr/Z6T7CqpXc7eau9/m3H0CVLdoaDlUhwZrQ3Vo22iyFEu9pVe3/2rEPjBHH4kDcm8WOITV3TkGByVoAQ8lvlYMg1wBxD8wrjyIozHOTOmqfXtGq45ntOocr1DfNycFMRotfp95Yzpp9RHfXp0I8FmUfBpQRXfKcYDa9rLOuobMIQo1CohDH5qPo2iq97e378EvwB8eGnwqG8l5dRXcNZxgsn27UxLlzKEl9FCIk649lzQ4O7bLmgZZM5T0ej/NBhrA2Da5KyA9R7KSfnLKbQYrHmbIbOHLztZ56TGd1FWz5I4MctaCjCDbVeg/PCbPLzur5DBElshRpr6VY0F7BlwuiFczLygnvnSBEN+MXvCoedrCzYV2YbBTbNZmbwQP8WgtvW+z8fOHy002QmBLgSXWiKmFxJUITM0zcBEKnIPk3RPsRLksOWIh2CD3dg9OVOb5IDC7URdCsOtjq4T3kFHOIQWQSrGToKiDvT5uJJZxxa3wMdk25ppEx4PJsA0a2ua5fpuUWGkFIpU5toBHAfCWCnOIEb2d2lgRaUHJrqeJXDwj13OZ+FdCrW6o1Yma3lzgwqj22jFvizsQLZAE9zVp69mDG3r1DD1crsETpLrIA2rC8pF/J8tJrPZsPnL06kgvz8eN+kBH9PLdmIldTEPS9V12zJxxEGjxI2PoOjgNrkcxzKJns0XnAus0I+rtZoaluhmyLuuAQYm/E5gYyjgTHyIGIAgUmGoMTcnfyLIw53+j4zW/5WSmx9f4lzGgpRs4+tk844B1HLBuYoC2/NsbmTbp2hWUgeKAcYCDuf0pElhGMzHP0CqN6kR+m/pganCAVXNOdbpvPuzPA5z9jdEX2DptAyEYIXz6lhqdvje0MB3mlJUUHxY1WOTXDyALL+jN8JtuoWJm/trkRYkH8xoNXhXwpaP0kkjy9cTdvyniVZHmnxhpLKjGWuf5/M8AHc1P8dHtAI/etZbeDrD6FrTMJWjLbyLLXkS2/B6wwmpvnTu70rOMhTu0svdk2TbpZVS5KxJW3CU1V0JyE9TilU+WcnKnUv7uheWXIqWEc3cZLbudpvROlK/8GokVt0gktzpUty1Uty1Uty1Uty18ydsWlt+1kN4vs+qWgl7hYP5jZ95XHXm3AZWOkNtw+ujJ7zScrnd0G1ElDWWLjFksa4oyxY1BTfd4wk/4luIPFem4E5k/XYiliiwZvAIJoav564RjKWhLYQpZH1nZQvgYTAhug64Q4+O9ZEhoRMgAb//hPjcXwjXYB0EhPg6xXotHeYDq74Et3F7AtD3DaQuJ3uIzdhBMJrHCqyCBiXjCOKDAR0AcxFknNmsNJ1BKJJIFVK1JeyXAG9EhqoJuRhDhRJ96Fk1ksNojYwFU03bjGRSJFrFmnAtyLvy0qpivsj1GGwBifSz8KXobLJSE0iIzwrvjywJFIKbs2w5BONq2nfQ2tgUiNuVCh51Gs9Ek5BHoCHBGhq79w5eFP3uZh18LV7emO+9fy9/NtHMQq3/bU9wfQ2FjU4009d/r2vL6L8CYMdaKodH9Pe6jYDH0AR9D6MAi/fXHea0TPwFxs59CAM1ECruBX780tyzbgn3xzQTEYKaH2aNZ2TZbzj47xd2q2tD+uc+J2QII+R08xJ/7tRv4FzHx1IgFjej5fS3ZUIM2hm5SgShbgNtfUMyHh/8DCiToZQ==
|
|
sidebar_class_name: "post api-method"
|
|
info_path: docs/api/v3/identitynow-v-3-api
|
|
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create new Service Desk integration' (create-service-desk-integration)"
|
|
---
|
|
|
|
import ApiTabs from "@theme/ApiTabs";
|
|
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
|
import MimeTabs from "@theme/MimeTabs";
|
|
import ParamsItem from "@theme/ParamsItem";
|
|
import ResponseSamples from "@theme/ResponseSamples";
|
|
import SchemaItem from "@theme/SchemaItem";
|
|
import SchemaTabs from "@theme/SchemaTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Create new Service Desk integration</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/service-desk-integrations"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Create a new Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.
|
|
|
|
## Request
|
|
|
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
|
|
|
The specifics of a new integration to create
|
|
|
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the Service Desk integration","example":"62945a496ef440189b1f03e3623411c8"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Service Desk integration's name. The name must be unique.","type":"string","example":"Service Desk Integration Name"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date and time the Service Desk integration was created","example":"2024-01-17T18:45:25.994Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date and time the Service Desk integration was last modified","example":"2024-02-18T18:45:25.994Z"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Service Desk integration's description.","type":"string","example":"A very nice Service Desk integration"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Service Desk integration types:\n\n- ServiceNowSDIM\n- ServiceNow\n","type":"string","default":"ServiceNowSDIM","example":"ServiceNowSDIM"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>ownerRef</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Owner's identity.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"Owner's DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's identity ID.","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's display name.","example":"Support"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>clusterRef</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Source cluster.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`CLUSTER`]"} schema={{"type":"string","description":"Source cluster DTO type.","enum":["CLUSTER"],"example":"CLUSTER"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source cluster ID.","example":"2c9180847a7fccdd017aa5896f9f4f6f"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source cluster display name.","example":"Training VA"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"cluster"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility).","type":"string","example":"xyzzy999","deprecated":true,"nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"managedSources"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility).","type":"array","deprecated":true,"example":["2c9180835d191a86015d28455b4a2329","2c5680835d191a85765d28455b4a9823"],"items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>provisioningConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The 'provisioningConfig' property specifies the configuration used to provision integrations.
|
|
|
|
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>managedResourceRefs</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
References to sources for the Service Desk integration template. May only be specified if universalManager is false.
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SOURCE`]"} schema={{"type":"string","description":"DTO type of source for service desk integration template.","enum":["SOURCE"],"example":"SOURCE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of source for service desk integration template.","example":"2c9180835d191a86015d28455b4b232a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable name of source for service desk integration template.","example":"HR Active Directory"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>planInitializerScript</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
This is a reference to a plan initializer script.
|
|
|
|
</div><SchemaItem collapsible={false} name={"source"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"This is a Rule that allows provisioning instruction changes.","type":"string","example":"<?xml version='1.0' encoding='UTF-8'?>\\r\\n<!DOCTYPE Rule PUBLIC \\\"sailpoint.dtd\\\" \\\"sailpoint.dtd\\\">\\r\\n<Rule name=\\\"Example Rule\\\" type=\\\"BeforeProvisioning\\\">\\r\\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\\r\\n <Source><![CDATA[\\r\\nimport sailpoint.object.*;\\r\\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\\r\\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\\r\\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\\r\\nimport sailpoint.object.ProvisioningPlan;\\r\\nimport sailpoint.object.ProvisioningPlan.Operation;\\r\\n\\r\\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\\r\\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\\r\\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\\r\\n }\\r\\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\\r\\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\\r\\n }\\r\\n}\\r\\n\\r\\n ]]></Source>\n"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"noProvisioningRequests"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.","type":"boolean","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"provisioningRequestExpiration"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"description":"When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.","type":"integer","format":"int32","example":7}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributes</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Service Desk integration's attributes. Validation constraints enforced by the implementation.
|
|
|
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"description":"Service Desk integration's attributes. Validation constraints enforced by the implementation.","type":"object","example":{"property":"value","key":"value"},"additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>beforeProvisioningRule</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Before Provisioning Rule.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`RULE`]"} schema={{"type":"string","description":"Before Provisioning Rule DTO type.","enum":["RULE"],"example":"RULE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Before Provisioning Rule ID.","example":"048eb3d55c5a4758bd07dccb87741c78"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Rule display name.","example":"Before Provisioning Airtable Rule"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
details of the created integration
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the Service Desk integration","example":"62945a496ef440189b1f03e3623411c8"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Service Desk integration's name. The name must be unique.","type":"string","example":"Service Desk Integration Name"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date and time the Service Desk integration was created","example":"2024-01-17T18:45:25.994Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date and time the Service Desk integration was last modified","example":"2024-02-18T18:45:25.994Z"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Service Desk integration's description.","type":"string","example":"A very nice Service Desk integration"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Service Desk integration types:\n\n- ServiceNowSDIM\n- ServiceNow\n","type":"string","default":"ServiceNowSDIM","example":"ServiceNowSDIM"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>ownerRef</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Owner's identity.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"Owner's DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's identity ID.","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's display name.","example":"Support"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>clusterRef</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Source cluster.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`CLUSTER`]"} schema={{"type":"string","description":"Source cluster DTO type.","enum":["CLUSTER"],"example":"CLUSTER"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source cluster ID.","example":"2c9180847a7fccdd017aa5896f9f4f6f"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source cluster display name.","example":"Training VA"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"cluster"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility).","type":"string","example":"xyzzy999","deprecated":true,"nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"managedSources"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility).","type":"array","deprecated":true,"example":["2c9180835d191a86015d28455b4a2329","2c5680835d191a85765d28455b4a9823"],"items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>provisioningConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The 'provisioningConfig' property specifies the configuration used to provision integrations.
|
|
|
|
</div><SchemaItem collapsible={false} name={"universalManager"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.","type":"boolean","readOnly":true,"default":false,"example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>managedResourceRefs</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
References to sources for the Service Desk integration template. May only be specified if universalManager is false.
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SOURCE`]"} schema={{"type":"string","description":"DTO type of source for service desk integration template.","enum":["SOURCE"],"example":"SOURCE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of source for service desk integration template.","example":"2c9180835d191a86015d28455b4b232a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable name of source for service desk integration template.","example":"HR Active Directory"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>planInitializerScript</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
This is a reference to a plan initializer script.
|
|
|
|
</div><SchemaItem collapsible={false} name={"source"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"This is a Rule that allows provisioning instruction changes.","type":"string","example":"<?xml version='1.0' encoding='UTF-8'?>\\r\\n<!DOCTYPE Rule PUBLIC \\\"sailpoint.dtd\\\" \\\"sailpoint.dtd\\\">\\r\\n<Rule name=\\\"Example Rule\\\" type=\\\"BeforeProvisioning\\\">\\r\\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\\r\\n <Source><![CDATA[\\r\\nimport sailpoint.object.*;\\r\\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\\r\\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\\r\\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\\r\\nimport sailpoint.object.ProvisioningPlan;\\r\\nimport sailpoint.object.ProvisioningPlan.Operation;\\r\\n\\r\\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\\r\\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\\r\\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\\r\\n }\\r\\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\\r\\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\\r\\n }\\r\\n}\\r\\n\\r\\n ]]></Source>\n"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"noProvisioningRequests"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.","type":"boolean","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"provisioningRequestExpiration"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"description":"When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.","type":"integer","format":"int32","example":7}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributes</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Service Desk integration's attributes. Validation constraints enforced by the implementation.
|
|
|
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"description":"Service Desk integration's attributes. Validation constraints enforced by the implementation.","type":"object","example":{"property":"value","key":"value"},"additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>beforeProvisioningRule</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Before Provisioning Rule.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`RULE`]"} schema={{"type":"string","description":"Before Provisioning Rule DTO type.","enum":["RULE"],"example":"RULE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Before Provisioning Rule ID.","example":"048eb3d55c5a4758bd07dccb87741c78"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Rule display name.","example":"Before Provisioning Airtable Rule"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"62945a496ef440189b1f03e3623411c8\",\n \"name\": \"Service Desk Integration Name\",\n \"created\": \"2024-01-17T18:45:25.994Z\",\n \"modified\": \"2024-02-18T18:45:25.994Z\",\n \"description\": \"A very nice Service Desk integration\",\n \"type\": \"ServiceNowSDIM\",\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Support\"\n },\n \"clusterRef\": {\n \"type\": \"CLUSTER\",\n \"id\": \"2c9180847a7fccdd017aa5896f9f4f6f\",\n \"name\": \"Training VA\"\n },\n \"provisioningConfig\": {\n \"universalManager\": true,\n \"managedResourceRefs\": [\n {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180855d191c59015d291ceb051111\",\n \"name\": \"My Source 1\"\n },\n {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180855d191c59015d291ceb052222\",\n \"name\": \"My Source 2\"\n }\n ],\n \"planInitializerScript\": {\n \"source\": \"<?xml version='1.0' encoding='UTF-8'?>\\\\r\\\\n<!DOCTYPE Rule PUBLIC \\\\\\\"sailpoint.dtd\\\\\\\" \\\\\\\"sailpoint.dtd\\\\\\\">\\\\r\\\\n<Rule name=\\\\\\\"Example Rule\\\\\\\" type=\\\\\\\"BeforeProvisioning\\\\\\\">\\\\r\\\\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\\\\r\\\\n <Source><![CDATA[\\\\r\\\\nimport sailpoint.object.*;\\\\r\\\\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\\\\r\\\\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\\\\r\\\\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\\\\r\\\\nimport sailpoint.object.ProvisioningPlan;\\\\r\\\\nimport sailpoint.object.ProvisioningPlan.Operation;\\\\r\\\\n\\\\r\\\\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\\\\r\\\\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\\\\r\\\\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\\\\r\\\\n }\\\\r\\\\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\\\\r\\\\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\\\\r\\\\n }\\\\r\\\\n}\\\\r\\\\n\\\\r\\\\n ]]></Source>\\n\"\n },\n \"noProvisioningRequests\": true,\n \"provisioningRequestExpiration\": 7\n },\n \"attributes\": {\n \"property\": \"value\",\n \"key\": \"value\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"048eb3d55c5a4758bd07dccb87741c78\",\n \"name\": \"Before Provisioning Airtable Rule\"\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
Client Error - Returned if the request body is invalid.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
|
|
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
|
|
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><p> An example of a 403 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
|
|
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><p> An example of a 404 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
|
|
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
|
|
|
Internal Server Error - Returned if there is an unexpected error.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><p> An example of a 500 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div> |