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

107 lines
37 KiB
Plaintext
Raw Blame History

---
id: put-reassignment-config
sidebar_label: Update Reassignment Configuration
hide_title: true
hide_table_of_contents: true
api: eJztXOtv2zgS/1cI3YdtC8uxnaRJ/OXgJumd99LHJQ4KXBpsaYm2uZVILSk19QX5329mSFmSH0n6QPdxRovWscjhPH8zQ5G5DXQmDM+lVsM46AdZkZ8Lbq2cqlSo/FiriZwGrSDnUxv0r4J32nxk9RHBdSuIhY2MzJAIkDgXWcIjYZn4LG0u1bQxnkVEsnBrsok2jCsmY3gk8zm7kfmM5TPBlLhJ5iwz+hM8i5uz2sCQFVFhYAYwdRtcWmGA1Vx8zgdFPkNGZaz6prZu2KDQL7KY5yK4vgP2M254KnJhLBGTKETGgUwrUPAAfirZAxXBytFMpDzo3wb5PMOnNjcgZXC3rIhCyd8KUckmcbYRvxXSCNB1bgrRCsRnnmYJkulFR93DzuHBYZcfdON43OkedsdHnaPOeD/a7+yJAHnF6cLmL3Q8Rw6WqUWoBDAKPOJZlsiIpN351SJDt6us6/GvIsqDZc5HYAC/EhvDUmSmCNRJNoPPTn1MTxhvWvd41brMgnaSmh64itkN+hExAfo36IO5FNaJ5MiJ+KXRKTrlsqLXcVtTMss1K4mQb+UiZROgFXyZtls1Vkb6ezGS68eysQtscGTDee6Iln6IhVNVpCyBuEPbfOKJrKnaQmBxCEBgZSyYFQmYHkLLGWmzFZFfoIpBNTg+Pr24+OX89N+XpxejC3hyfHo+Gr4cHg9Gwzev8YtXg9eXg7NfRoOLf10gNlSirk4GPdGT44WAyD6KbHNu8hOM0EcpnZwRTcxuZjKaoeKJwkL9iEKkB7SBBRogdMohTgKcGuYyFU2zdHq9sHMQ9rqjbrff3e13e+3dvf3/IG9Cxd/Imc42MNZmbDgBK0nL4C/YSRVJwhx5GMGkijGkwZKcQcikXKG16jDX3iQbUuJjFG4Fd7ysu51R96Df6cDfdqfTAVnvlk3kPWIIvJ47eIBBdxQpNtPKugjudTr433JW2IgSDkwQHL8rfDmOHH59FVCtQNPiwaM4iMVEKukQc4LGHC4AMIq0idGm4A6Y7O7hDDLbJxmtwqR8JB4NT3B1XGTB6gr67B52OO/s7x8C+sAnzifdo73OXreD7u5S4ENL/bMAZwzBE2N0MhZLC0XAnOHke9Z/J5NE8pTB/2jiusOVygp7FQSeiJzDyBo33Bg+X2HGj8OFZ/rGxZed6SKJEfgqVC+rj2FlcIcPX54gYal7jFgy5N0sE5GcyKiZEZ2I63Pi/2EGAPieiny4jbjfKeK2GdhlYJFm4D/fJQVXwkF67Yb0d0T5tk/pthXwIpb5KsptcPkBjganr7Aln4kGK0vNlguKjemNCnzxCC8fYpDxxKkWsQsFBPUK5TnAYGM33LKS5DeZ2xN5sUWBH44CqY4hUz3GJ844ZJxy+JJnVK6J+v82ZyiX2HrDj/aG2teDOk5tbBP8gHNfiQd3DzQU1TAYt7euiThOJNrm1BjwqBAMlhcG6zg58f5Vq8gQwRXVP+1v6Sya9nZge6zjRxjjpVQinBoukUNBLEcw0e9pod+l2giP36V5aFy7YR7QRLvLXvCY+Z6LHXthUJ2GRx+B1mO2Jy7dflQ5BXcoyshcs6w4EHz8vHPU25s83+O8d7jXPdgfH0347m7naP/oiIJRWMun4uGK/B9CCQMVb6IjsMh/QSGYpnzjRYvfV3s3bUA0Hpn83diFmJ5fhhuFLUjgL47fsr0DlnA1Leh7Pl1SggovL1a6Z5DcEX5j5FSqdayU9fLJ6cvB5dkIvvFVb9BCWiubpgNVVhbAqu9b8koAzKVlud5mzzzVZyAQV7Y+ULqf7NziZhOAHy+SHGb41dfMqJN2dVI9lCK3q8qeyLZot6BrQJTnOdRRY25hgnYp/9kgikSWh2dek8/YDEBImKdtNohjgl+oFyAagSjMn2P7wWPc2JWOwKSAUBa0/auLnCmdA9w2bVGpcnkvo8SUs7pRMDiA84f9ZBDlBTBHYtajcOEtnsWy8ou95prc1TtCUulc5TwCKXiSzEGNBpIfIBPIJnPLPByhuSwAjyrHLRCrDpUEd68cMye5pmcRL+wj4u5tAvATkmiLB5+EDz6Lic/vsKM1SjN5RPJZkSYv9uG9LsrAZ5CKk3gbu9vY3cbuI2N3+WFZ9/inVPp0V0ufS8UL0K+h5LlS+hjyHqVZOciVrc6QLXxj40ukn9+NILA/Qqcm8QVdhi+PvmN95FL5CvODhT3c92OquktjNWyBDJIe/cYsIJGI+8R3xTEpyqlqd3W1l9qMJTioWlMiAmoaNtcF46AyUyhq/7ltsVgLq37K2YwDPkJrAPw6BMRVVRxmWrrWfltJbivJbTbaZqO/RjbaVpLb2N3G7p8zdu+tJBdcUbT4OskWacrN3Hmaf+7ejcOA6pX5IuTIVMvVChJjixoraFYOwbjXHXcnB5HYi/le/Hz3aNKLnvf4/kH3oDve6x0E9Vx/VcXxIsiaMVWzt7MjqRi3Y6GOKxQ4l821jpvbfwW+kJkgrCH0LOpm0Dmo9HpRO/aOVmvHkdbsFVfzskKyjRpSVTpCTIOxKY415VgYwNkUcFHhuyEJfKEr4RZ4yAxuiScylRS8I9pvzs08HExyEMUFSulki1WkipICOCQkSLTbq77hEoQUE6z5gAJVsFNA5+9YnXoTfVMlz85R4jOUmJ1+joTAQF9U7vvr9neHwLxBjLhwBt6w0eu6Ha7AAaAhcJi1qDu39fm2Pt/m+G2O/2vk+G19vo3dbez+OWP3C+pzXw1trs9hwKPr8308wMsWtdRLdK4fXqZTqHgOyL2ZjqLC0HZzWYNTXQGu5C+eIIbgtYt+sLP55obdua1uY9wFeBEES0XHZWESmD3L88z2d3ZuwXhgtLs2z2S7nKT0TTvS6c4YNLYGjNy5L3QkHMAGb4e+2WiTuo1Ej3bwR8Sd8klA9F0wAm0U30u5PI4x1wUAHpFp4fFM7130NbCYQWvxk6XRbfKmFflArkuT3H27LI7QBlnWqe/e1WA8A06XREQRrqt7OxdYh7vVV27vVLkFe7feymJvcFiPvRDcQJPgXmc8+fnd6CmbYvVJ0V/gYW4mJLYLED9vwUUI3Qbl1j5OooRjdDF1d44GjZcnGE1skoDA7L26EIJdladhXgPsnwNOk0pxkiBowFnXT0rrxOKTSDAjtitNouPJWO2AhnZ4Y95Tyn7UJkjljkfhRaf3KmQnEkEJXZ/GeBGp62NXWSkXr8n1tUz8raQWOmohUbNPl7hwqr2K3GGcCEIaSXA8gwja+urFHb2wRg97KvgGqS7zgJrwfDRfeUWl1b6ajwa9EOk1+Xiv3tFB0uY05pCsPGc+ZNFMayv+zhi6DobB1bSAKPpqtuj0akgREfY6NZZCt2QoQygUib8zCAzlnImPMVFTnaKhhFOxC8kPZFmI+Q90Su9DQ2b6+gryKY6MdWS/mmdcMMQFQ4cB1vPvz6wCs3gYEGRw50/JAY4r+xMSeEZruOdorUV1Ir9DczA1RMAqUbFZ3/3QrwDOf2L0AEcvxgAMY529eAnI8RKOo3VHp3Rryip3CJY1uMpvoiFVLunN8bvYocL0+UeTFyUeVBspb1Qy/94ovQFJ/ji4+zsh3hZp/opI4ytf3JA8r27znpY9yrobsA/fVl29rPrw1dLmzdI1t3Nqd0A2n8muXce45yphK8DwIjUvHS3GoH7h69PVjUzcaZ8J+BeeEjZRUwEtW3VTvE4oS3iOUUwoFs2koC2QTPAca90WRpJOCXkyoxHuoNElQlO6Y2DARByaVpkAPdqkL1fmBBCukEY/xp9tQX0YrhXNoKUWbfYOulIVgRtiR4rHTODZr9q3phfgiW/RkdlJ6dxQZKZpofA4OrBdpIxDCD0QAbG0UeGAGuynRKkLTaXuYlaJWhhaKEKbejOT2jeTC3+avXL0B9YCP7d+ax1Uj1b0F+MrQc5F4vozGNdsUx6iDdEVzkSSoZNAlhF4Brxa4dVwtEIRiCkLckWirc10x0+yOzgWiGA76Nxnt91td0Jqj+D7TNscuvga8Ut3jf3em28Nh7ytXi/8oN9z4HMsNkc7Ge7xoSSFa9Zct3wV3NMtA4V+7bcXQAM2Ay3gpNtb3BvC/vEOvwYgwo2Hq+uqNaSWGqyEnwFQJoCT4h59PDn3v4zgKVv7mw/WSlLuaap5tZ0RwMePAndBapzfXcNot11FfLkB/v1IOHK3JksCKy9+sHl2M9wW2L1jr2vbEm8v0f3G/tctpG6DxfAbBFz4tx+8hz/wg86cuhG+8fvboNyuhDGObFk6rquc/AdQPwz7H23cfeU=
sidebar_class_name: "put api-method"
info_path: docs/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Reassignment Configuration' (put-reassignment-config)"
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>Update Reassignment Configuration</h1>
<MethodEndpoint method={"put"} path={"/reassignment-configurations/{identityId}"}></MethodEndpoint>
Replaces existing Reassignment configuration for an identity with the newly provided configuration.
## 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":"identityId","schema":{"type":"string"},"description":"unique identity id","required":true,"example":"2c91808781a71ddb0181b9090b5c504e"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"reassignedFromId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The identity id to reassign an item from","example":"2c91808781a71ddb0181b9090b5c504e"}}></SchemaItem><SchemaItem collapsible={false} name={"reassignedToId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The identity id to reassign an item to","example":"2c91808781a71ddb0181b9090b53504a"}}></SchemaItem><SchemaItem collapsible={false} name={"configType"} required={false} schemaName={"ConfigTypeEnum"} qualifierMessage={"**Possible values:** [`ACCESS_REQUESTS`, `CERTIFICATIONS`, `MANUAL_TASKS`]"} schema={{"type":"string","description":"Enum list of valid work types that can be selected for a Reassignment Configuration","enum":["ACCESS_REQUESTS","CERTIFICATIONS","MANUAL_TASKS"],"example":"ACCESS_REQUESTS","title":"ConfigTypeEnum"}}></SchemaItem><SchemaItem collapsible={false} name={"startDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date from which to start reassigning work items","format":"date-time","example":"2022-07-21T11:13:12.345Z"}}></SchemaItem><SchemaItem collapsible={false} name={"endDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment.","format":"date-time","nullable":true,"example":"2022-07-30T17:00:00.000Z"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
Reassignment Configuration 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={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identity</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The definition of an Identity according to the Reassignment Configuration service
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}></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"}>configDetails</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Details of how work should be reassigned for an Identity
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"configType"} required={false} schemaName={"ConfigTypeEnum"} qualifierMessage={"**Possible values:** [`ACCESS_REQUESTS`, `CERTIFICATIONS`, `MANUAL_TASKS`]"} schema={{"type":"string","description":"Enum list of valid work types that can be selected for a Reassignment Configuration","enum":["ACCESS_REQUESTS","CERTIFICATIONS","MANUAL_TASKS"],"example":"ACCESS_REQUESTS","title":"ConfigTypeEnum"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>targetIdentity</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The definition of an Identity according to the Reassignment Configuration service
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"startDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date from which to start reassigning work items","format":"date-time","example":"2022-07-21T11:13:12.345Z"}}></SchemaItem><SchemaItem collapsible={false} name={"endDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment.","format":"date-time","example":"0001-01-01T00:00:00Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>auditDetails</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Audit details for the reassignment configuration of an identity
</div><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Initial date and time when the record was created","format":"date-time","example":"2022-07-21T11:13:12.345Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>createdBy</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The definition of an Identity according to the Reassignment Configuration service
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Last modified date and time for the record","format":"date-time","example":"2022-07-21T11:13:12.345Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>modifiedBy</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The definition of an Identity according to the Reassignment Configuration service
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}></SchemaItem></div></details></SchemaItem></div></details></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 \"identity\": {\n \"id\": \"2c91808380aa05580180aaaaf1940410\",\n \"name\": \"William Wilson\"\n },\n \"configDetails\": [\n {\n \"configType\": \"ACCESS_REQUESTS\",\n \"targetIdentity\": {\n \"id\": \"2c91808380aa05580180aaaaf1940410\",\n \"name\": \"William Wilson\"\n },\n \"startDate\": \"2022-07-21T11:13:12.345Z\",\n \"endDate\": \"0001-01-01T00:00:00Z\",\n \"auditDetails\": {\n \"created\": \"2022-07-21T11:13:12.345Z\",\n \"createdBy\": {\n \"id\": \"2c91808380aa05580180aaaaf1940410\",\n \"name\": \"William Wilson\"\n },\n \"modified\": \"2022-07-21T11:13:12.345Z\",\n \"modifiedBy\": {\n \"id\": \"2c91808380aa05580180aaaaf1940410\",\n \"name\": \"William Wilson\"\n }\n }\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={"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