mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
113 lines
35 KiB
Plaintext
113 lines
35 KiB
Plaintext
---
|
|
id: patch-non-employee-source
|
|
sidebar_label: Patch a Non-Employee Source
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW/tv28gR/lcW7A+XuKbebxQtFMe5OvDZrh8XtIrRrMilxDuK1PERRzX8v/eb2SVFSvKjadDeHZQAhkTuzs7zm5nV7r0VLVUsUz8KT1xrZC1l6szPovB4sQyilVJXURY7yjq0UjlLrNHEwjs7fylOfU85KydQ4gcZyplaqDC1bg8tVyVO7C+Jak5TSBFiqsqnJky4Jl4tZZz6MhDZ0pWpei3+NI3rfxYXNEdOQdnzVeCOxMFBKBfqUJRIHwq5XMbRZxUn+Og4URammo84OTgQl+qXzI9VIuIIZJwoTNWXVESe+OS74ShUSTzSa36qQT6wAfoppkLKe8s3jM/xihbGN80xtLQpn9aR4DexXhSqTONMHVqJM1cLaY3urXS1ZCpp7Icz6+HQUl8klEHPVLPd6/b6rhr0VcdttIaq15i2nbbT7brTbs+1Hm41ZZWkbyJ3ReSqLIxF4Ccs3A4lG9WKwtIJayt2wYhII5HOlZi8vzo/01q/fTVP02UyqtfTKAqSmq9SrxbFs/o8XQT12HN6w0brtUhSGboydms7pGZlwxXAJ0wU+A4vW/8pAXPsDX+kj/R6Sz8yjuUKJP1ULZLS82j6k3LSLd2PBTHOfIvzXD4hE/iJ54fKFdOVmFy+OxLEtLDFfypmRbgJgoVdBW4Bi8D3sGLqK+YTr7asvMnt9bxkBVL9VAl89aJ4och7VJgtaBnpal9awLn5wzKQHIXmgRMtSUcp/IEYWXtSPvLBcPksR2OhXxjFRD4MFwuQQeDAguwhYDqV8UylgmgS2zIUKuBoN0JID0CQanWnZSGtMnf18tpg8bMMMsW6C9W5x3G3ye168pm6Kwc/ie+nQSWkiukkBVCgPL/daKxn5O9LUwr/yscUDwoScOYUS02zVFvc4MJy7gf+0np4KFHLvTgnpr8/bEEjOQRrwegxS6BDuENViYci90F+95H846MFK7j4bEyO7+v4flJx4LPg6z3CkKOhiB1+XUyeaL8ueaB2K6vOwpdMGGIVrZAwCwLWxSMzC9BeT59YLWfYHDSGXr/Rnk7bfdlo9hudhmx5wMTOwOljbGcwbXqdXtsZqkGn1Qcyym6j35y6g+aw2ZkOrNuHWzIClkyWUII2UqvR2AWXjELQ5y641JavWU/iWBW8ZBBUHbjwnipI+O6ukKT4l1jFurk5ebsVopWMa1j0GXbXNpaNdqPdG7TsrupIu9Px+vbUdVp2z1G9ZrPV7QydJkVckcOeBYYiqQFMk8jxJUX3nU/xP/eTnbm8wpE26KDbGzjd1tDpNZr45MieN2w4zXazTdxof3khJzT4K3m5VKn0A1qxQvmFC5cefuX624QqQbhVbp0i+e3EpqozrQNpy8FPTTVQjrWXJtjqIvrtDmA2qer78x+PL8/GZ0fH//z+8vzmAq9O3h6fXZ9c/72amoqnm2o+cSnRoMxLhO8x8Pn8JF0JKJfKRkRHsH4IBJRiRlKFMoRaZ3GULa2d6jwxc96m0TXxD6XvjsBdHNH6bsWOXfhwo9l12y1vADeWze6gafy83XVb6jGr5vQuladiBZ4/wHcQhDR8o259wpR6oFjkI/cW/XVadBG5JPvTSE8FuZ36nEOrrH6Yq5B1Zgp+cYdqNpD4kBPeANpGc2g3Bnarfd0cjLqtUXdYa/Za/yDVOLEirPqWnBiST/HQaYza3Vq/Tzw8UM3zKNDRe7DZ2ZWjjwKf6svjOIZ72Ojm0iymgt54VM7TFP0QeZUfopbQafHFWfvpOHE5axxF7gty1Dv0GvYsltxyKGbZwURB6Otzn7WIYsoARJKimUTgcVVFQhO1pngjXe5eSb4jIwz5YSydn0HrJen7JvR/oarSTIHfF2XljmVVX8lprzFsdbxeR8rWoNPsd6dDT7bbjWF3OKTVFypJADxlgMmBp7r09ypUse+IIHJgkX9BIXAZ6J4Z4MVfjlVM4wX6pzpajy3ENPwK6voPgS9vji5Ep49ICmcZP5ezDSWE9s0VtfuoX2nnQTezkFwTPo/9mb+zasiB8+3xu/HN6TWeXB7/7eb4Cp+I1lbRPw7hrS65JViFL8yjO+bYCEBRlqC9on6qJg4M1QMIJNG5lwb6+luySqBManhlFqSYYVbfMaNMWnhxtKiEUr5F8sqvqdoh2hHCHO6sp5L6kkijwcHYcdQytU+NJg/EXElXxa9rYuy6PgkJcOfKPsH8FfeHrkuhqwl4GUJZcQEVZSmyQepvVkxrVVatscaS07JRKDjA+QvaXSfNwFy+E1SEQ+EthkVjH/CsNVfl7noDE5NVmEoHUqANWEGNcQwNC/SJwk8TYeCIzJUAeMJ8XIFY5RzDcPeDZgY5jt85MkteEHcXAeDHZtGKF5+VCb6EGkyNRmyN3EwGkcwuEE82owpz5YGvd+L2sbuP3X3svjB2N19emp0J85ZLn+Z26XMTygz6jTl5bpU+MXtPGIl8kN5N1IY8pGLalEjvP1wjsH9GEYfx6suSNpC+YX2kU/mOvZXcHvr5NN9DzFP/2hbEIOtRS+ABiZQ7Yr7XHLOitKra26u9i+KpDwcNd5SIQM1YrKJMSKgszsKQOJHJoXAjlYTfpWIugY/oq8CvRkBaNXTtJW2D7ivJfSW5z0b7bPT7yUb7SnIfu/vY/W3G7pOVZMEVR4upk5JssZDxSnuaec/7yAIDRP4bmShCrvglr1ytEDFR1FhWtXKwpq3mtOn1HdVxZcfttYdey+m1ZLff7DennRb9aLfO9ZN1HBdBVo2pkr21HVnFKOI+o47LQjhXkkaRW93+g3pj5RGs8Q/Ted0MnUOlt0Xt2Bpu147XUUTnVlZ5hZRUashwrSPCNIxd0Ng4H4sBUsyAiyH9hO+DL3Ilf6FAJabjFoG/8Dl4SQrQjVf22KNf13Wg5E5WrOKHTpCBQ0aCINJnM+6kDyGVRzUfKHAFOwM6f8Pq1Jjov6rkxSVJfEoSi+MvjlIU6EXl3t21v3tCJw0II660gR/Z6NXdjgzhAGgINGYVdee+Pt/X5/scv8/xv48cv6/P97G7j93fZuz+B/W5qYYer88x4MX1OcbWGqKopd6Rc/3Py3QOFcMBu7eIHCeLebs5r8G5roArFYfMrdJZwtIBKlsfoErq9/lZtQeM1E2AZi+LA0zKD+/ew2qw1kNNLv1afqIkjO5qTrSof27vwCA6LKDjDSjmZg7vPY8vTkynUWNdxz65s8Y+XkBrnqUjx4UFeJf4Sfp8ZA0mXUESockcCri+cS1+DDaX6Cu+S3h0zRwj3ZARst3EwcNz8vzYfkoOTeQROXap78m1MF6Ayw3xzIGPRMH8IMT2ugE/Rxq0xhkZfHJbHnNFRbrmcGvkOvFQY9faYuichrXEGyVjdBD6t45X7z9cvxYzKk0ZGrKEqmLlUy+B4LqAGzH0jfN9f5rE2SiOstmchRtXflmhUBNeAKWIj+GVUmKSH/85Q064BIiz2mmSYtygWevj5a76rAJKl7W1tsk5fTesQ4t1WZn3mlMj9xB+qA/p4GntY2iLtz4hFp/fpzFGRG4JxWSZyyVLcn0tE3/Iqdmams3UktcbXGjVThx9UsdBvBMJGSSsra9eXNOzS/So4cITorrJA2nC8FH9PczJrfbVfFTo2USvysfH8MPcp5stlWlCw5xIkDYDV5wIZx5FifqLEOQ6FCqTWYZI+2q27mhRmyPCbjVKLNl6Sdu3UUUyf6cIjFA7k5xSFuciJkJ9F7o6bD+xZYELn/g4+aeKzPx4gmRLI93ISb6aZ1rQpgVtjROJ4V/nMnIsOpIGGRgHtAMcre3PSGAYLeGiprUT+Zl8nedQ+nDAKlNJliP9ZbQGQfNJ8AsaXYwBTFMRXvxCiO/C0OKzm2Vl5dsHmxrc5jeIkEc39Kb5LbavKLf+2uQlicfrXZbzMFh9a5R+BEl+Pbj7f0K8PdL8HpHGlMW0W3m5vtx3/Pzdm+o1KNMYbN/zQZFFrswimd6kHEC6WtzeT6QN77nCX7xlFODaHp1TfuWBboWsyYC5lOKF8cKZ+4p3IpZKplR5HpLPRguOcZTbBCzoN5nQjE8Sx1CGRO/oB6BXEx/Q6oUOzEdtHp3dANWfItPvXcGCfEVNvM2dAsXZYpGFdLQbTGQLIeF6z3iO6ydOpgEOXV+ocskiLhGLWXm0k0uSKmrc8MSL5NyjLWt0wyUHeWYt+Edi9quhyNLlsbUglyooLm9Vy//naMMr7bkKltRoAp1RqKnSCj+cXG9RBLHQXFShG49mUlKnsXQvD8JrZ2jX0F7ybcIoSdEVl+hemFu9letJxXXhjYs2xUb9b+MysMlnNKa+pM02UkGmmycdhBNrV9OKqaPiihXCbw6t0dj7e9qboRbugR4j1qnxn9yuOzQOdxiUPqNF9gBF6gktvjLyuK9F+fbxTr7zrcRwVQILfPxZ0eZDwS4adTDMe0TMjH5tfpSw+bLFevpTt3qpf9WT9RbUE9MYo4ptgYvx9dFfMXpqrjgv9BZHLO/wkP6OrI/4jy/RUkcKBvHzeyvfMMQYTZj+/Rvz2+BL
|
|
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 'Patch a Non-Employee Source' (patch-non-employee-source)"
|
|
---
|
|
|
|
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"}>Patch a Non-Employee Source</h1>
|
|
|
|
<MethodEndpoint method={"patch"} path={"/non-employee-sources/{sourceId}"}></MethodEndpoint>
|
|
|
|
|
|
|
|
patch a non-employee source. (partial update) <br/> Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`.
|
|
|
|
## 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","description":"Source Id","required":true,"schema":{"type":"string"},"example":"e136567de87e4d029e60b3c3c55db56d"}}></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"}}>
|
|
|
|
A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
|
|
</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>
|
|
|
|
A patched non-employee source object.
|
|
|
|
</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={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>approvers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
List of approvers
|
|
|
|
</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={"NonEmployeeIdentityDtoType"} qualifierMessage={"**Possible values:** [`GOVERNANCE_GROUP`, `IDENTITY`]"} schema={{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group","title":"NonEmployeeIdentityDtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}></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"}>accountManagers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
List of account managers
|
|
|
|
</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={"NonEmployeeIdentityDtoType"} qualifierMessage={"**Possible values:** [`GOVERNANCE_GROUP`, `IDENTITY`]"} schema={{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group","title":"NonEmployeeIdentityDtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"approvers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n }\n ],\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\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={"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> |