LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e8c6d4aad70eef6d6870aafd342c04847f4cdba0
developer.sailpoint.com/docs/api/v3/update-source-schema.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

154 lines
52 KiB
Plaintext
Raw Blame History

---
id: update-source-schema
sidebar_label: Update Source Schema (Partial)
hide_title: true
hide_table_of_contents: true
api: eJztPWt3GjuSf0WH/TBJFrDBr5gve4hNHO7YxgM42bt2ji26BfRNP9h+2GF8+O9bD6lfYGN7vTNzs+RDDN1SqapUL1VJ4qESzFQoYyfwu3alVUlmtozVIEhCSw2sqfJkpVqJ5SSqtK4q/DiqfK9WbBVZoTPDftDrMlIinjqRaF90RRyISLnKip075c4FQxTSF+qnE8WOPxEMWCQRfpHit0Hv/ELG1lTM5NwNpF0X1/61P5wqMQ5cN7jHZhH3GTvKtSMhQyUcz0tiOXIRti0s6ftBLEZKD2i3EEZNODb+70tP4V8rVPgOP3qB7QA0G5vBYID0vYM4AKLSsoLEj4WM49AZJYA90CTFJAySmVB+7MSu8uBvVcyDRPhK2dhgKu+QC3mkHV/MXGkpjcutE3Wy3i0Rh4m6xRdnSRQLW40dH4hJSQ1CAsfDIo1X0raFE+Ng+CKi6fj+bhrHs6i1tWUrYDhOZz2SjjsLHD+uW4G35dj+lpw5W3c7W0x/jXvWeKD3wDQYSzMO0UbggOsJDnwrxq6c1IX4DOion9KbuaoqpgonIOKWE263zLVQjaGdb/E0a7LiqTS0Rhl9wKHb29s/ogAY9XDtC/h3XaFZq7TgE7WJritV8yqez/SrwbDfPT/JveJx8KUGVO5x1Ds/7xwNe/2bwdGXzlk77csNQWKoWdM6bHzc/vjxYP+gMR5/tLYb8Gm0i9+sA3t/u9SthOx1hV8uUrxyKsPthob4qCrCwAV2qNiqM4MM61TKVhaDYPQHaFaeE050lrixgyBRnnLPc7K24u0JY8nPr/0FTcC1D+o+kyHQEqsQlf6h4qCGz2Q8hVdIJHxj+QGDUa2E6r8TJ1RgOwi+5n6l9UAMx7YgDf6ksijbDKSeDQroaB0gaeGCV5rzO3t247AhP+5vN/bs5sfdvb3RrmzuNA8B2Gq0aGxC6wk0yhivQIsl9eVofWfoKoo/BfYcR18/2JL1A7vIBkVbTlJ1wgjRsQI/hglF2HI2cx2LbPcWak5thmD+HT/i6yUWyDCUcwDhxMqLcs9Zpipl5No51HrGSQgZaeW1xWgurvqfj8T+4XZT1Ki1oOaZSYqDwI3qjorH9SCcbE1jz90Kxxb2eF8QnivwQyR6MJ/AxVmIdix2FOEJr5YmchUrU1eG3ANPAF/BsHkKBUL5iYfDgAmlgb3gTtEHMtDwST+wghnyKIY5RESy2TctFxrLtRi1Bb/QjEFzrEJQ7FmoInQi2tDGMpyoWCBMcjPgJ1lnNRFyPIbZYXbHeSILsrmVHxtQvJNuooh3vuqNSY/L2Gadz9W9yPcH8tFw5LUm7Y5UTFSY77+zvZ31MO9zXVL5Mm3SBykIEGbjNWjGtULPpo7rzCqLRQ6akWIDjL8vlmISFAjiguYjaZXxqSkTwfJqGaR31ygf1xXyttdmyuF72j56knGAZ4rXb6CGpA2p7tBr3ZmohLFqKd2ksonnyXCOwgOeHiORfASCiCtALBjTRxeiqUo601esJlq+WUIrWxlXt2qVnFRo/rqBZURJc5e9ac6A+onrllnbAQqCuQIUsv7aDVVaY+lGqlp0P7mn5Hb098Xi+wL/oRpGM2Aus6W5vY1/HrXL92CDosSCSDQaA3YmxLTXmMeVNjEVxaLFceznWRwnnY1BaqFf5Mf0TDxnLGz51Gg6UGCgGHz3iLYhAX7pAMwXgZ0E2lN6jUBFNI/Af3CUkrmmzK5FRaxgaYDGADhKgfO8nZf3l+GUKYPxkJZ0rcQ1TjLxHfC9gkeC0D4klQYt0sQ4fsmXZlhG7bM2s+8c5wODFScC5f+/RFePoI3Us1G1eRGVONFU2QbbKVArQ2v6NvjeT4NIG88om1gRQKvQRKCIohTpuHXR80ETQ/Bdd5J9FwesTEJJKDzljVQIfgkFw7fcxFYXKvScKCITm6E+gvhBSX8J98+wJgEMbNJvcKT3U8XIhQJXgUiOhotBgAEsYIU3zYs3mA2JfYGUySRUk2z5s4LzbLKqlTEsoZJQRc+IrDJfq6OP9uXwS+d82D1qDzvw+Kh3dtEbdOnzcbcPi5Kbi07/rDsYdHvnA3o4OOp97ZiVCjzpnLc/nWL7s/Z5+wTenPZ6f728gAfnvZt++/y4d3bTPjrqDLD7Rb/3n7/D30Gn3T/6Ah+GnbOLUx778vy0d/RX+gBG//JoeNnvHN8M2/2TzhD7Dr60+52LXvd8qB8yvK9dxI19xEm/d3lxU3o4+P38qPzsoj0YfOv1j5Hky34fOHCTewTo9i7hUe/89Pebfudvl50BDtY+Pu4OAUT79Ma0yF4Cse2Tk37npI1NDC6Dmy/tr52bs87Zp05/wM1yDC2jBW81CU+2WcWgFc2WJ3CJDf3OZ5ixy8vu8XIOpUcfpCuMfLGJtcAoQPQSJbNZEOowEB7xCqx+7X8QeZlqiWGaGDB9Iogto6gWT0EfJ1MhE5BvMJDsGQlCKoaru1uBNwsikG3zhrIIpvMy2auhhAqo8lG/jiHcsuKcwms4BVFfDQSMnwVxephlhCKynGBhw4iiNl5QE0RWlUeQkTYlaMb5fI8DK3AfM0o2GhIYiz4TrKK2rUbODYIfCBSsnid9OSGUKMcxp4QVLOdxGIXBJlnPsQLoAArG1bmUYKY5DTa5rM+ER/lhARM7AKlB+6dREiFwJPCQPoiViD2UcFExhwbv3gtY508DG+KpaZC4ttApNHBUyATsoH7OePkBFl2vpwgRMi2F0VFSYRogRACipYCA6udcuzX2HFpmxTcyuEaGxTRrXhUwMMib78OY0BPxiICZYMa16QaN0N2Qo8BJkiVET4s3EpgBMPE+I5NTGraI+MmYRPzMNvEx+X1EZCAI/sESk/j8uc6wlq3GOs1IfPAYiYXqb4shLQxZlJeM8SsgsbdDjgymwDxakNZFNwbWAtNh1sFpOcjxOQcsYGjax1Vxety+0ANFZuZTo7YkACOYamIVCc99iLKseRXVxRd5xw4W2KbNnHDAuzrG2um5unPQLqTiiVzGZrSWQJUBpMEZB/Ba+ronCwLLuF5R5xw/okY9Rjn4qIZjVk9tZZl/2siaiEDbuWVn9yzitT16K9JJGMoedgmRFE7KewjbfQtUxA+SyJ3zPGoP/ERvdBz3QWgLayr9Ccy/GDiYk9TiQK19dUdpDaDaNI+qTKeT2pUAg0OzCAfbBxr6R+JblKtJg7I8SYZH7J9KMUNLDAIvRRljrSg1eegcxtq5mcjWSsIQA1iDH3nNFUHHY0pFGT1KYhtuIs5BEueLAawcjwct64HbtqNDgFRjtMnPhTot0U4JJ7kv2/yVclsMjAqoeIGtwMhytM6BeTR1ZjpYlvpRbnWgl4P5fDQ4GrLwgJFvCiXRchdjNLmT9nyK8lvs/lJJT6cPcAOjlZYWSrQ9Ed61RJeXB3n9ynsWKhdloq7tB/qLZfNBXiy1YuS/lsMeUvpVMszlKr2KqmIBx8HAIEo88lurcGNjtYRdDifNPWNKdLCiaSXgM87XUm0M9C7K9TZip1NjMDSojXbyoCA/BC1kimRrfj8dML851435/H/F81wM+5zlR4vR0tlm48118pJ82dp5I5Sf0CaDy5o1zj8Ck0IiobSeNrlXrit95nlaXXoqrrJyiSxjmgsDXZWXvk8vLFctRr8vKDs5diaJTgevrcB8CajW7c8hCo9DKQrdOZwrY+/JucloFwh44KrkGRnzXJJIp2IoNV1MwZdSG8sczMw7FYTId4HXmDrWFKXYK+VRHq06FTOvr8uHprisS+vFOhu6DI5TnU+CS5Pjj6V30ganPfoD8Tr8/6nXO+20z3HJbwQ0nYHjlHWUp13kK5flclJWEzYbAHjOtXc1UUFQyubpPJ4nZ/CunmH/yASs55D2+SOFSp4iZT/Bl3LFvVhZW3pL6eJnlvwYl+4xR5y5svlMx9bBypz83v5Ha695aO1vN+CTJffHh9tWY6ex87Kc/DSBlX4Ng1/aiGJSusuZ9CISpItU1irCXF9SLA+YvV4nu+0zoXVBGGVIazZvkW/NBA7mwUO4NZI8ezmJitDHEppkSdVSuejNEcKyajbAM1HStaq3RSYrlJhIuY57nRxeTZmF0i3tDcL1aXHT0C0Rg4GKbvHhAzjMDx9wEN6Sk260MWV6kwPJBKN+7a9nwOJJa1VZ5L1jWlAsGdzlsqIWua8kGS8rFlbTUdLyweNly3TOlowL25a1u3uyXSVaWcuTflJaMC0Txzs+SrSZh5o0/Lqg0IB3pj3P7KT7QnIVUQ0ARRu9r4yxVoSbvWKHZiJnArcbh7VGs9bcHTabrZ1ma+9jvbG9+19Io9kV93o8XAkxrgHzAmx2GsPmdgsQahpschKotyJysXh3VX34CKw9mLZOGIK410TfZHI4w5MG36PAnlNOxQfj5LxlydhWsXTcI1hNr+fdZ1DM2iSUpJ+KULYCW+d/KMvo4YY8BmkMO7UrGnXgRL0hPkkb6GX6jjQxyLtQWpiP7j5jMi+5dGq6YF3bmI0Vw6oDJUf724fN3fH+rpTNj7uNg73R4Vju7Gwf7h1SXdtTUSQnzwglT5SvQseivQSu83dgCAgy8J4QoMGfHzwSjGe6bm6bkqnxFTGE2lUwop+OLsTuAUizP0nouZyUmODXLrHEhBsk0BdrXa5qJHqhM3FWunQTFB13PrcvTzFATMtaCGupMNT2jW8BVEEWpsE97/9gAmg3BO23xczoBw31Q5obTRvqEoOu32trDz306Ct65EGLcRh4BVUivfkZi3dOXdWr4LRQ72m32Ehimk+HpR/AIahZXDvVnPwgphC9qPB9XbSzjFcapJL3k7bNeULaTpvQatuk3MCjOlYpuMlYWZyNzICc5icFlQMwf0a8ZcUJIEdk5rUwlRaNop4fwJk5V8RumGMasXTux9KKda7dCkLKM4B/FQ5V20iDKXkKhsc37VKLlbeLZO7OGJnjOKB3nHlYq3cXLpifGpGWvrhTWvkiKveQNVL5xKS2SHqNQZ11q3S6jOLzVu2N7m50d6O7z9Td8su+3hWn31Lo01gOfS59rOkHITnPpdCHVwV+IEwjzh7xRFZxjaJDpN++DUGxfyif6uA/Z7gp8g3jI3blK9IaZj74+cjswDGuP5sLRJD4yBSMwRIpu0V4ZxgTo5hVO8ujfQ7CkQMC6q8IEXEPAR3ooMpy4lMdVUZVKrH4f4n5gIeupZMFpP0Cdo1PWmwiyU0kufFGG2/0y3ijTSS50d2N7v45dffJSLJ4CEXHSbmjJ74554nUSgENhDmfIVKVS4+S5KMVBCbSGKtSjBwqo2Zj1BgfWGrXlrv2/s7huGntN+XeQeOgMdptHlTyvv4q0+NUyYo6lZtvnkdiMe1AxK14IFxRHAR2Mf2X0NFKKs3HWUgMcwcBnD6NQrHj7nLseB7EQBsAhtgxfCS9eNk/5RoUg0e+cVUuCNMjFYVdO3QmehM6bkLHjfvZuJ9fxv1sQseN7m5098+puy8KHXfXhY67LwgddwWGWGMMsf6ZoaPt8DmYMUwK0GA2j6f7NnT2Uau93rdqAr1CFNk8XLGRKgjEGW7p08FSVMhE+hm70LxBWw/bhqYtHRuagIn0cWepE/DxY8dTGJNiMd51PCfmU0UK4YbzWnuM9w6wzhh5S0fRpyQjMgpugLnXAGTMic2lMACB8qATMNRvmOPUs/W/ygeLPlJ8ihSLzk9LKdT5NP+7t2qXQBePX6G5GPBcP7JdIDR7hhI/Pf+UhqCbUH0Tqm/c/cbd/xrufhOqb3R3o7t/Tt19Qaiuo6HHQ3Vo8OxQHdrWt0UaS32mbcP/6IidVEVjQOItAotidTuLwSmuwGO0FboqzsK74szVSPoM69aDucxusaVvFIBH+iK5BbTnVQEjmYQudDWXmz3A3MGcLepy5tTN/TZ+cE+XLt7trLBE2UF/sGV2wudf8c5MHqROHA8dOlVGEksDMP/15uxKerfjk/DNCYQ5ECcYTDV3wJse470OsLr4S0St6/qarRKNQNtl6C7W0fN15yk6GMgjdKxi35NjQXsBWJbIQ/S/43SBEAAgmi+8fOiITVc7wWm/+p5vQ7uKGcOllpn7wSJBcwmhHjZrik9KhnjwlfbNvPvt2/C9mGCASgaCLzhVDq4oQMUuQIzIALbNHhLsRD4pu7ugXdilgwonxi4wRVz7A6XEVVcz6hw8Qx9MObG9XbjT4/k3ghbvAnlPDpJWEo7Pu7b5oG1NX9mRncpkEvlez6uZoUvm6HotEv9moNUYWo2gRe9LWDBrryze9W2B1iMI6UbErVcPzvBqOXi47IInCLWMA188QngU91ZZZtZejUcBXg3hFfG49r/RObtiN3NngD503xXWNAgi9R9CoOigqlxNEtC0V6NFh/tqpBG15nYOpRoPWXNqEEsSfqegGD4LkxyhL6dQJuCsCqntLc0s2IVbOvN5W6CZHl+By8WWdmBFr8YZB6zhgDW2E5HGnz0aChboNtJAdoAF4Cibf7IEGtGcXWRYKy0/gd+iPug+LECVoESzFn9pZUZQfxL0AlunbcBMV+hON73bDC9G0bDorGaeWSaJUObgMr5uAN60xDfGNy2Foof9V6MXKW5nuRa8auytrfQjluRfx+7+kyzextL8ipZGB8eYs+xnFxZ3cgf66DLR7HZcEzUXr4nVy4Ple1C/471+44BI0iuUvAJxtLicVaRr5BX8D2/JClCED+un7JKYPBhALuaT5mAvrKmjKB8xU5Kuha+izAYe6TiE22hYlL7VZEJn5UJghoQVpOMCvLr4pm/oCnGxh/uAAeofgV71DWAG6cYkcWyEAoIzz0t86Iv6m3hCguitkRy8vyxhA6fvnmCE+IKstJfRdhRJZAWd2lahF/XGmLiGNXFOQNaMBfIR6aw1MDI7Yl/JCOkrN73cthj+r4MNUlmbKpeOR4J1hkBN5UY46w6XIAIwX5dK8EZo3SnawrZ4bzEQz8KwU4dFJt22HEQxrI1zcC/5Ymx9e7g+e/juQoaoR+/LYvWQZew3P1Sw+aGCzQ8V/DI/VKBjP1y0b80wPY3mIuFEAzusK/1TBWjZWrlfLdCZHnpqfjQAfNYUTA12enjAtCbmPRb4GBwk5syuvmdpDfKR5obI3BH6R+zOu76+Zfw9FWYLv3uwkgqTivfnOTcLH38oTN6llGDC5vVY5H/m4DVYGM7RAXbO9BJf+LUuLdboYpOs+1O/WoDkcGdOJD/RjWKMNLl30R7S/bYj/bMLHicqQ3kPD/H/VgXkHFEPZuzpoBE9f6iYtD+0YcD4738AlUusZw==
sidebar_class_name: "patch api-method"
info_path: docs/api/v3/identitynow-v-3-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Source Schema (Partial)' (update-source-schema)"
---
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"}>Update Source Schema (Partial)</h1>
<MethodEndpoint method={"patch"} path={"/sources/{sourceId}/schemas/{schemaId}"}></MethodEndpoint>
Use this API to selectively update an existing Schema using a JSONPatch payload.
The following schema fields are immutable and cannot be updated:
- id
- name
- created
- modified
To switch an account attribute to a group entitlement, you need to have the following in place:
- `isEntitlement: true`
- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group:
```json
{
"name": "groups",
"type": "STRING",
"schema": {
"type": "CONNECTOR_SCHEMA",
"id": "2c9180887671ff8c01767b4671fc7d60",
"name": "group"
},
"description": "The groups, roles etc. that reference account group objects",
"isMulti": true,
"isEntitlement": true,
"isGroup": true
}
```
## Request
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id.","example":"2c9180835d191a86015d28455b4a2329"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"path","name":"schemaId","schema":{"type":"string"},"required":true,"description":"The Schema id.","example":"2c9180835d191a86015d28455b4a2329"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json-patch+json"} value={"application/json-patch+json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><span style={{"opacity":"0.6"}}> array</span><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
The JSONPatch payload used to update the schema.
</div></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={"op"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`add`, `remove`, `replace`, `move`, `copy`, `test`]"} schema={{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>value</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The value to be used for the operation, required for "add" and "replace" operations
</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"string"} value={"0-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
string
</div></TabItem><TabItem label={"integer"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
integer
</div></TabItem><TabItem label={"array"} value={"3-item-properties"}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><div><span className={"badge badge--info"}>anyOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
string
</div></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
integer
</div></TabItem></SchemaTabs></div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></TabItem></SchemaTabs></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
The Schema was successfully updated.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The id of the Schema.","example":"2c9180835d191a86015d28455b4a2329"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the Schema.","example":"account"}}></SchemaItem><SchemaItem collapsible={false} name={"nativeObjectType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the object type on the native system that the schema represents.","example":"User"}}></SchemaItem><SchemaItem collapsible={false} name={"identityAttribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the attribute used to calculate the unique identifier for an object in the schema.","example":"sAMAccountName"}}></SchemaItem><SchemaItem collapsible={false} name={"displayAttribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the attribute used to calculate the display value for an object in the schema.","example":"distinguishedName"}}></SchemaItem><SchemaItem collapsible={false} name={"hierarchyAttribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.","example":"memberOf"}}></SchemaItem><SchemaItem collapsible={false} name={"includePermissions"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag indicating whether or not the include permissions with the object data when aggregating the schema.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"features"} required={false} schemaName={"SourceFeature[]"} qualifierMessage={"**Possible values:** [`AUTHENTICATE`, `COMPOSITE`, `DIRECT_PERMISSIONS`, `DISCOVER_SCHEMA`, `ENABLE`, `MANAGER_LOOKUP`, `NO_RANDOM_ACCESS`, `PROXY`, `SEARCH`, `TEMPLATE`, `UNLOCK`, `UNSTRUCTURED_TARGETS`, `SHAREPOINT_TARGET`, `PROVISIONING`, `GROUP_PROVISIONING`, `SYNC_PROVISIONING`, `PASSWORD`, `CURRENT_PASSWORD`, `ACCOUNT_ONLY_REQUEST`, `ADDITIONAL_ACCOUNT_REQUEST`, `NO_AGGREGATION`, `GROUPS_HAVE_MEMBERS`, `NO_PERMISSIONS_PROVISIONING`, `NO_GROUP_PERMISSIONS_PROVISIONING`, `NO_UNSTRUCTURED_TARGETS_PROVISIONING`, `NO_DIRECT_PERMISSIONS_PROVISIONING`, `PREFER_UUID`]"} schema={{"type":"array","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING","PREFER_UUID"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.","example":"AUTHENTICATE","title":"SourceFeature"},"description":"The features that the schema supports.","example":["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"]}}></SchemaItem><SchemaItem collapsible={false} name={"configuration"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Holds any extra configuration data that the schema may require.","example":{"groupMemberAttribute":"member"}}}></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></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The attribute definitions which form the schema.
</div><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={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the attribute.","example":"sAMAccountName"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"AttributeDefinitionType"} qualifierMessage={"**Possible values:** [`STRING`, `LONG`, `INT`, `BOOLEAN`]"} schema={{"description":"The type of the attribute.","example":"STRING","type":"string","enum":["STRING","LONG","INT","BOOLEAN"],"title":"AttributeDefinitionType"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>schema</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
A reference to the schema on the source to the attribute values map to.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`CONNECTOR_SCHEMA`]"} schema={{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The object ID this reference applies to.","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The human-readable display name of the object.","example":"group"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A human-readable description of the attribute.","example":"SAM Account Name"}}></SchemaItem><SchemaItem collapsible={false} name={"isMulti"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag indicating whether or not the attribute is multi-valued.","example":false,"default":false}}></SchemaItem><SchemaItem collapsible={false} name={"isEntitlement"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag indicating whether or not the attribute is an entitlement.","example":false,"default":false}}></SchemaItem><SchemaItem collapsible={false} name={"isGroup"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag indicating whether or not the attribute represents a group.\nThis can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute..\n","example":false,"default":false}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date the Schema was created.","format":"date-time","example":"2019-12-24T22:32:58.104Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date the Schema was last modified.","format":"date-time","example":"2019-12-31T20:22:28.104Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"2c9180835d191a86015d28455b4a2329\",\n \"name\": \"account\",\n \"nativeObjectType\": \"User\",\n \"identityAttribute\": \"sAMAccountName\",\n \"displayAttribute\": \"distinguishedName\",\n \"hierarchyAttribute\": \"memberOf\",\n \"includePermissions\": false,\n \"features\": [\n \"PROVISIONING\",\n \"NO_PERMISSIONS_PROVISIONING\",\n \"GROUPS_HAVE_MEMBERS\"\n ],\n \"configuration\": {\n \"groupMemberAttribute\": \"member\"\n },\n \"attributes\": [\n {\n \"name\": \"sAMAccountName\",\n \"type\": \"STRING\",\n \"isMultiValued\": false,\n \"isEntitlement\": false,\n \"isGroup\": false\n },\n {\n \"name\": \"memberOf\",\n \"type\": \"STRING\",\n \"schema\": {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"2c9180887671ff8c01767b4671fc7d60\",\n \"name\": \"group\"\n },\n \"description\": \"Group membership\",\n \"isMultiValued\": true,\n \"isEntitlement\": true,\n \"isGroup\": true\n }\n ],\n \"created\": \"2019-12-24T22:32:58.104Z\",\n \"modified\": \"2019-12-31T20:22:28.104Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
Client Error - Returned if the request body is invalid.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><p> An example of a 403 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
Not Found - returned if the request URL refers to a resource or object that does not exist
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><p> An example of a 404 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
Internal Server Error - Returned if there is an unexpected error.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><p> An example of a 500 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
Reference in New Issue View Git Blame Copy Permalink