LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/get-service-desk-integration-list.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

123 lines
51 KiB
Plaintext
Raw Blame History

---
id: get-service-desk-integration-list
sidebar_label: List existing Service Desk Integrations
hide_title: true
hide_table_of_contents: true
api: eJztHGtz4kbyr8xxH9amAAMGY3ybpFjbm/OVvfb5kb0re6sySCOYrJAUjWSbuPjv190zeoHA2LuXy+ZIpRI8munpd/f0PJ4qER+pysFt5UqE99IS7Eioz+zEi8Qo5JH0vcqnWsUWygplQH8eVH4UEePMlSpivsPMOByWG3UU+czxQyYeoZv0RmwZeNVgbMAi/7Pw2IOMxuw8HLGBPZEeg+GFUbqVx9HYD2U0ZVKxUPway1DYAIBxyxJKsWgM7cKzA196UaNSq/iB0FOd2ID8SETlGJ8CotA74CGfiEiEyJSnikSCf41FOIVvHnyBP33HUQL7FtlyTs0MZvUBCcGc2HUBQRW7EYMPDXajYu66U6YCYUlHAtZEcNWVExlVkYSAj6THIwHjQz8ejQmOBqEad96VEOz2p102uDhhVxH3bB7a7NB3XWEhDuwixf3T1jiKAnWws2OLe+EiCxqKS1czxfInO9L2dnggd5SBU7dSOPWMB9skxIkfCqALfk6IVcjVhPOVA4e7StQq4pFPAhf406xVlDUWE145eKpE0wBZJpHPIoRxGohu2m1DA8hUTuIJjbOFw4FW+D2b1cqZT8xa4P0Zf2RePBmKEFXScAw5GoooDr1vhnft7hdwb8If9W+CkvIS/iJuGgYqPyTtrhXZu4CTiqaIEU1ZQRQD17ehIQpjUYKjikIw88psXjJXMF0qkFihK0ClTljH1NSLQHh60BBsAkz895XTX5EjgFfdYLl954G66Db0MSoOAuSZTfIkywYw/gN+Bit2bXXAqlXkbrVayclSMzzHeUe6/0XO55QDaJ/wuhJII+C9KJT3hMkfXCyaXfOCeZ+0ricaBlMwHQH8UB0ghGpV2tUqyEz8WgOyqrpNy49aTQuyd7Gf5cYKEMh/KAhd2kz8ytpWv7Xf3B/uCadld3ZFswW/hrxpiU6v2W92Ksvcm+XH3qJ7O3FYFaVfZTKCoAFxJfCD2NWRQrDqv+rXfsTd+iGOrqJcA4isgo0Ft0HOFGawY4mLHHOA6MeuzYbCeEuUtpOGJWRgVYe8KnsQ6M1GHjg1u0F2Ij1LUBgWOs5z8LqACiNCmMU9Nub3AppBBqSg2F9OAm5FNaSGgjgqLIRsmNjzI3TbSuCsVQLyHVFeRZwI23vuxkJzAXsD2rFKsPkmnPwSOx76viu4V8m5bho5m31CaFqkCge0m038X1FHTp/LxwCw5UML6BcM5kHgSou+7fyiEMLTIko8DDkqp4zEhGaG/OXcocTI9PCHvwBPFhS2kLfJDI03Ksl+rBJG3WorKAKr6alqFR6BoxvGEfAAGBKEKLNIao5o65lnyQoscECDXaNNwC82AaMmTfIkaHIjmTTnXDMLX5bJsg/a3xeReAFOuY6rMRiwe3AazEM4y+AhIhrCuhgw7K5dZD0B+8F/uDo6OSu23Hkl2KU6WykOLWNd8glQ9B88EV4K5yXKdY5jgF/SBl2GhQAyq6gOCeGLSJbBObo+J9oRjvAwgbqtnBwdf7g+uf43qlqGf9oKmEt7/RkSTNnJUaPAEB0neGfP4eCpRQfihDPsQLjYt9rNvd0+TpTo9npT2VIFLp9qBS8yXwfLygw1Q0bURqPQN8w+QauJbS8Ux5Ufh6BOZvBrhVGEUiqTw9Obq+vjy6JIksY1JTI3Tbk89js93nMsy7abrR7n3f3+ntN3Os6es7485iZaLpbrkEMOD5Hzp0FBNBrAoR4/L6JFqz5MKUpzoaWGvhUKQMaCcDucskzoNYz/gIxJp4bc+vyAARSiYQADh9IFFd5e7Zoep7/9Nu33+8SPACI7JaAU8ma4QvH4SNiaNFXimjTTTo7UC4kAjbuXCpoBn0Pfc+Sokcx1KRRBBQJVjUH8yKgcYzazHqkLkbBk2VMkN8eV20Svdrt2q9/i+3vNVtdu73e63WGHt3fbyK621d3Lden29rIu/f32bgXFv0jnIhMxqL1Z7PiGGbPMChCKOGzR59iwFXMpKkUkAPJMVzmOpN6gaO0QQSE4Ke6eEf9LNPUqnf1hLACBUJdsimhIlWKiBVkQcZJwajUBR8W0jOHv0J8QVX44ajAGiTPJAjJFA8fO6wPjoAAcVwyQQGakZZlYCAn0uedOE5EWM7O5nC5T8PwciwyAVlA8D9HFVDfB/DmFB80LMOUHss7Ak/iAFqYsWTUJEuR57iMfCdVVqvxCR+/M1+VKkXxlGEj8PmayKptPmfnsVfMlceLq/Oby8LgYJkzbmlECnOhr5p8PI2XmPgRz5+uHkb/HoFJ1VEM+dE2y+kWo/f2SDWARA0uyI0i6LVgVT4thJ1s+aHlXZgvZdnleiX4nEZ3WIFBPbaxG3+0XCqlMKFSl0IiVcBxcqNVt9y3gOPyyOMTtptXabe3mOb6Sw/lAvWK+sylL2IPcy1x9KlBDjKYlxY80wur2SSPglxg2uy34J6sApJBZi6oELwbXhn/KwLV1BgHUeSeejCR35W8ivCJWlEkTXAf8yzPxUZGd4XjQsxQA06OejwyGiytmuoxdodf45JNV0edLD2wk1gt5a8y9kVCrc5G3PzxOXFwqIYTv3rQazTcM6PBt6Pjdm5vr9/X9Nz98f3cX3t15b/9ydH54/e+LY43Exc2705NDdnd3V8mqAnZkY0N5awKHhiPvv8PWY40MAaWxiC19eSfAeMVFjsAcFMbeHmU8+l73ZfnOGs2HsbTGCTNQdVGFdc1LePo3yWwCNDvTxtudPNR0Kq0f37/9y+3h0eB6cKs/yAmuFlhGqBZro/q31d/zWF6ArjQGFpVxLnXI/rLRjfNkM+fFcJLqwevweOl083jq/6K/3mJFknDfKv/nAVlYYySiYj+1tc222VMiNQj2W3NDccx5sLXdgD8h5m+xRawI2xS3xpHWGFaAzObBKgL7PLQz0jK2/bcE0uyrInvs/Q64zvLiYuzTp+/f7hj7uPO0r/f8PPREOot+7YOJIOAu09KVqbeOhUd5aWayFGb4PVo2DCmZwIRUSpo9AU6N1ERnsEp4UW7LEN1plgeU5rXP5bHBIgLHj4E0paUFUj8iQQb9QHh2IUWn7Vik0q5p5GByWH6puYr0GLiszIanphhjgs7N0Yu5mLMMtSfUdWNYMShpC9z+FYgc/B89H6T6ru9h8ssdh1hGIQuXdtKdZ8mKrbWUJ718fnSxuAKbFWqTL6n4ZcMa7CcIp7bO3JCwCMsCEbIOEDOrXGSORJwmIPB5StKoy21b4jfuXuTi79yS9CkJzrC0qVBFHUZ+FtlfSPNwIUZh1HnJkmFZ5Hrt8mBpJCyrF13enM4lmNSy5hpg6VTzNaNmZ18Md+1u1+ryTq+7P7SbPduyhvu9Xqdl9fbXT/YJ/PJKURlGAxlG5BZJMnlFXUwwsIspJNGeQknKP7djMJuRx+uU7TccuhLdznEYQlCrs8vc1lHeiIe+TSc1pHePCt54xS7EknzSxjKOe0hbo89x9j04nPoo1GUfQShDHmiKCuSuaAtHg0zSfupXFAFwotFi77jNErd8aIhBzofc+gywTtbQrhvaaGDJECazLcySaUVP8OFes9/uOHsdzmEp2ep1h32H7+42+90+lYknQilY8ueLU8lKf/74jidCaYGTtCiDt0FWHHivz+vg5CV1riUyIBhr8B/XhrpvSqbBF5apj1ENctR3hxes02PgqkcxtfPRHBO8+s0VLmxi10WVT4OVBnweypH0ylBJ/MHR8fvBzek1tFwe//Pm+Ap+IayF800DXN/YqJa+iUwPhLEh4IEriLi4FSjsBqsaqFUgCONxrqM0YX2qgJnMhFwYYWYvGZEHnZWyElMiu3mM2JZsiEYNYiG0QciCFcCQY60M1/y4Gwx5owii+qnhZNVsA2832CANDXoXVcF4KiJBzNB7/PrgEpiyoF1jP45wkxW8Q1EWGSuL0sicymleKGgcgPnzejKwIsgGSScKVphqi0HRyAdw1pybK6nnmEYsxcMMsHC06PiV5YchFSeANhkpZtwRnScAx+Ml/VKPlfeq5O7ONDLaQ4I/47Faw+4gD5VenUhLP9wLY3wqrbnaJI1ETMYjmSNlNNj0SsWVGL4+8bCx3Y3tbmx3Tdud/3hpTlkkuQ+mPq3F1OfGM4dQMXgupD4haQ+sQpJOOqnXgqzhqVaTIv3j47U5+IpLJL2C+Yr5kQ7lC8gPUnmYw13J2a8k9GeyQATvs2WJA55I2AeEd4axThKJVbuLs733w6EEBfVKUkTwmiGb+jGtYcPYo4SWqxqzfaG8N5E5OWSO9frpyd56erR3k0luMslNNNpEoz9HNNpkkhvb3djut2m7KzPJFCuyFpMnqXgy4eFUa5r5TtsFDDpkR7hTk9Nl2blsBYGxNMeqFDOHyrDdGracniU6Nu/Ye7t9p23ttXm31+q1hp12r5KP9beZHadGVrSpnLy1HInFeP4A8rjYA+VSke/bxfIfnbdy0K3RVmSSNwPPG7oQaXLHTskGih8BbQAYcsdwSXnx5vJUb1Cbnc7QnLzBNNscQqAtF0wp6bg4XUjbpI6b1HETfjbh508Tfjap48Z2N7b7bdrui1LHznOpY+cFqWOHYYrlYIr1v0wdbanv/TkgFKDBioG9HqaNAZCSnHRIzT7i4UhEaaJXyCLb/ZLjhb7Pzrg3TZIlVahEehm70L35dEx8mju84gFGI3CRHl5glJDdolbJicCcFO9f0i1JtGMkCOCG0/rAwYsY5u6l0bd0FulZbgwYklPAcyo47wOXUXK2BSBQHXQEjvor1jiNtL6oHswukeJTpJgdP1pCoM2n9d9u2SkBPFAQoru40rJeclxA18y5B8sI8Rho95WmoJtUfZOqb8L9Jtz/OcL9JlXf2O7Gdr9N231Bqm6yoeWpOnRYO1WHvo0mS3Op93R2+/fO2Af6KihhQOrNfItydTvLwYEJSkCjxHPFMMkNpPiHWpUHcTRGy5S2d2DurNXxzlqd47NeB3gBC33R/NfcgWnd5xMeXZ0I0FfznBc6Ko6wKzvLRuKbO3qxoWmPQxe6Jy+APIFKgCrMGjyQjeSqvuc/0DMgQ5BDiYvTV5ZQPbEDPTiiJ2iQEENJx/rJCAi4FmnyREJ6f2Ql5OQK2hQWOkyDqeEhZ6Oz1EwXlr1p8qIF6egCfUDXTejOvpwWDWgJLWXsWzkb9GeA6RyJFX04OVGjK8zu9ewLypRFLNxXaC9Mdo7d2uyd4CHeMqajNlv/+Hi9zUaY05JP0W8fCYmLELDKC1AR8pmD5NgJDqIwlr3INigc7EEbZY4LBDPzAs2JYcIHCCaX4P2JpThIkMPBUeu/P8ML45a8N4MPdOj7nKjt1MeQqN/kuQ0SuniOrtci8dcEWl1DqxM0fJ+pgIVm7a2lD4pb4CgQBHcVcevVk2t49Rw8XKlBC0KdxwE5YfAoHseyEqm9Go8CvDrCK+Jx532k63nFYUy7LqbG9OjSCbPGvq/ED4yh6qAZ3I5isKJXo0V3AutkEfV2M4dSXU9Zl3VIPwm/UzAMTysTH2L4p+zH14UYMsmfSbJg8z/T1ZqfCzRT8y0+1Ag9bd96waNKczjjhHWcsK59gDL46yCIigW2jTSQH9AKcJjJnzyBQTTn9zSsUq9O4HdoDIYGC1DVd1SDA/3HQebgzC9GH7B32gfcMGbv6QE1eohAw8JIWGBWUneY5+Aivq4PAXiObxrfdPcUg/IfjV6keJCVZ/DVhK/tpZd4kj+O3/0febyNp/kzehqTT6O60bRm4ZFX8ncmX1ssFyp6GRD+C1/JVil1h4VR9hhgHhA+FIFard/RHUtBhYZAcLpcVkPN8idkiUHoo/nj6y0IaAQ5eUSPAHBYGtKzOVQKT2bmZDA6sUS50nXV2BzM8M3V9Qb7KOhmfhziug+PBMO3X3yzALwCyVygYNlRImxIuiaT2MMntQDteMI4qNQzGmFLZcXaccEy0BMJL3xK/dJRiRWjqiEJdMVShBN17piLcjnBPzMXyF2ZAjawHqVoXmXICLkUbrpEKabtz8EGbauPhRvgyhO8LiRgIjfD2cn1AkQA5pldEz8c7ZhBagf7AhDzUgIM2G20Gs06LRfwMrCvIlgr54DTW4PPP+08r5ZPWSn/W3tE2oQwXHvsBFiYQ8bEei2kV5+3leWrT1jPjIGJ2OnpCQs4uBybYbN+/hPXpOYqePZe5FLW/X89NF3KeX1TOX2I21RNKvRgyvqM/LZejV7BiORR7Ffy4f/ujeYVrMyex34lMzdvK3/lt5VXCCt7UfuVwto8rPztPay8Qh+S17MzbfiUVTAhyuL7V1p0FHL1IL2Fkhu1cMigUHH+8RgTK75kaWt+4FSz2X8AdB3Zyg==
sidebar_class_name: "get 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 'List existing Service Desk Integrations' (get-service-desk-integration-list)"
---
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"}>List existing Service Desk Integrations</h1>
<MethodEndpoint method={"get"} path={"/service-desk-integrations"}></MethodEndpoint>
Get a list of ServiceDeskIntegrationDto for existing Service Desk Integrations. 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"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"sorters","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name**","example":"name"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"filters","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"comma-separated"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq*\n\n**type**: *eq, in*\n\n**cluster**: *eq, in*","example":"id eq 2c91808b6ef1d43e016efba0ce470904"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
List of ServiceDeskIntegrationDto
</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"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><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><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\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 }\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>
Reference in New Issue View Git Blame Copy Permalink