Files
developer.sailpoint.com/docs/api/beta/update-managed-client-status.api.mdx
2024-03-06 16:17:34 -05:00

93 lines
44 KiB
Plaintext

---
id: update-managed-client-status
sidebar_label: Handle status request from client
hide_title: true
hide_table_of_contents: true
api: eJztXG1T27gW/isa3w/bdnCIkzgvfLmTAm3TS4ENYTuzlGEVW0ncOpbXsoGU4b/fc45kx04Cpd2d7m43fYFElo7O63OOZMt3Vsqnytq7sN7xiE+Fz/bDQESpsi53LF8oLwniNJCRtWedxz5PBeNMpTzNFPNFyoOQxVwpGBZEbJLIOUtngnlEwtqxZCwSjsMHPhDIiICZR09zRqSgZ8wTPhepSJCXOyuCLzAi8OFSgJPHPJ1ZqxwNDpic0IxV5pkmy1LJ9JwwMhG/Z0EigI80ycSOpbyZmHNr785KFzHOpdIkiKbQU9zyeRxiE9fkgPn7+0tNQqj0pfQXOG6VoiejFMWGSzyOw8AjyXc/KuT1rjRhVYiNrAMbhi05/ii8tCLAhTVGFkCGSl/4FcyBP+AejRcnqP00EArnHBumN85dtgXDnmDNiUzmJMAGVgoNgaQhzPE/AbQtNBWa2W13uvDZCzMF9iTLO41mC5u86RU4zRRa8o9w5XbxueW2zeWYrH18cnyIDVJ+GsP/fFCj3nDqrUbdabg9t23TV9dxnFbLbeKUM6lS4zlzMeWx9O1MCa5Sx1bCS0Rq5z1qClw3lkGU1jw5JycDXiMeXgUx8dup1eGvA1dCGH8mBLLltBv1bqvZa7fadZRHBZEn8mutTr1bbnsXhGGgSldC6fHwQFxbexMeKkHm8z6lCfeE1h6aEz5GWRgWtkVdDN/1j+BylqF69VUwrp+BLTBE0ELX/OoaYoesanqEPEUbLtutBkakKjc0W26tSVJCu7HyBAZ6PEF1QkNyHSiZYPBGnyJ5E0EkLHnbEDtRNkcHLZg+Pz44fDU4PjyAz8cno6v9k+NXg9fnQ2rIvwyOX8O39/3hsf50OByeDOH3q/7gCDpeomenFJEbHPYQp1xFBgNRG9HBus89ejUcsPWBMTuPwMT+PjKNaudjbNBwkKtCX/2lDz8Gx6PD4THpZTD4+epNf/jL4Rk0WTs4+CExRzjxfTm61xnPLzEZEfdVHCxAcFUGHeTQgtdtpFIRDAKsbtcd+Deq1/foX61Of34lP3jEKnAdeyRCxTJSGoMa9fo660Pq4St2E6Qz4l1z62/G9Jr1LwXanC5BrOM2NMSa9FRqKYGu22xiZCfTkSabAs+EFQcQyKHk/nkSQvMsTWO1t7ur4tQbZ/Y1t4M5MKtqqlnjc/5ZRvxGIUzuwiUAB6BS+wwwWcz2Vo73ZYYGccg4k2Ca6bSPDJtOhgf1u9rXDcvxh7cae4nrhtdzuvVut9P2/U7PAbDvtCcdt8snnbbruV0K9XGG6YBgFL0YsDxLxGgG3jaTIVKpQ/N0np5MJkqgf9uYX9Ax/CwU5/E04b4oUSjDJ3yxV7MHpBsbwL/jtppuC2l/lGMj0C/9q/PT18P+QTlhPYnKPSkrAkvL5AyB1hO6+NFZtFVv95Brk9AOI38k4YfdPziTWeIJqzT8CvMamhJ+1YzTmMS27BPLBPs0u71K8zNgOBQ8eg5snp0dFdmp6PEqQJWhv7wJFHxf6BRzv1PmtLuJ089glUfY1YlqlcHV1jX+Vjo8gb2OU9/A3kksoqOD/ukmRTqY/Ru1dut7abDjNJcsHizgQ+D9LU3dcTY55Vt/7D3GLenTrTndzvfjs/MAn9/fHyGmlQ7wQYU7ysq6rLXrDbvujhqNPbe757i/IqwFoUbteQwFpNOpN9uu03Tr9abTq7vzhfo9tItZ7Y8cEKeLNatT+wjl2/0lLlkApzSm6OLR6nYa43ajMbFdPnbtVrfZtntOp2GL5njc6Uzq7rjhVXHsiSNM7WpBrTc4e0PVXboBIFOeTEUlY811ZjxNJMCf2l/LHjOe6E9LgIaqlVaMsCKEhJIX8rum60opqK3jCwh2X0QeZWntK7jeqBJuOe6V221edXpY/W+cw5t+xQQpeMpY3lYnaW+im/d8Ou1JmJkaaEnaLfGsr0PK/gqakAbBFqtUKTjXOC76PpU8LaFhAZ1ROfPAMg2G8DCww5vUNsWBbcqYREw1O5mysa/tYAKdc1y4RTzyiOpNEPnyBoMGSnAYpL9DvZWko2C+jLWO3egVJe2vRUdTmWzo6uw13b1Ga9n1VRAFarahZysnqgvg7VJpu1T6wlKpP50OzTLJOE1r00LJ8HmYJDJhNhuKNEsi3HjTRjCbU2ZVoWBhcQ2R5H/Veml1+VFd2ej9vn3pi03uXGUWwkPYUGUHyKEglj0YyIDideDDCDaXici3EI0fUb9aRa2giZrDXnIf5NXy7RthUKcJ9z4BLUwnX2LoPApgPMuHsMBnYNGHphUdwcfteq/RmrRbnDe6LafjjnsT3mzWe26vR9AD6QqXSaW5eZLwxdrUr0UkksBjtP8TfAaFJABg4H3IAE2O+0+Q5tWXbUA0nqD/Ecil+xZiGn5ZKm7THcbZy/1T1uqwkEfTjNr5dEUJkX1+that92YjS5wkwTSIHkM2gLP++dEIWoaHP59D+BbBW2W2H4G3+uiWwCr4wkzeEMdGgBuumBIhqEP4NfbCUH0BAvFIlTsG+ptaAIjPwbcmPAtTGGFm3zCiTHq5fZ2HEsXNbcqeBTVR22FjbAMM8GZszHHL2wDIi77niTi1j4wmX7CZgOVl8rzG+r4foJA8ZBCNQBTGL4AQ476v98yRwCSDUBa0ASKzlEUyhUqxaoulKlexMweWo7JRMDiA8y/7Sd9LM2COxCxHYeEthkVjH+BZa67K3aikNFLpIkq5B1LwMFyAGpMENMzGIFuQKmbgCM2lAHiivF+BWGW8JLh7p5k5SCVd83imnhB3pyHAj02iFReuhQk+ujmg0YiskZvJIBJcRLFpsOlVmCsPfDYJROhvY3cbu9vYfWLsrl7M6x5zlUofZ730OY94BvpNKHmulT4JeU8kWd6JyhtjyB0GCjEl0tv3IwjsTyLC/uI2xk3eP7E+0ql8jfl+YQ/dPsbyozBWxRbIIOlRS4D7msLfI76XHJOitKqa67O9ksk4AAeNNpSIgJoJW8iMcVBZkkURcsLVDvOlUNFPKZtxwEfu4UJcIyDOGvm2vlG2rSS3leQ2G22z0Q+TjbaV5DZ2t7H7z4zdRyvJgiuKFlMnqWw+53g3Bj3NXEdpOYMOLH9QgRUhR6ZarVaQGCtqLKtaOVjjhjN2Jh1PtHze8tvN3qThtRvc7TgdZ9xq4C2fZa6/WMZxEWTVmCrZW9uRVIx3kqCOyyJwLpVK6Ve3/0C9iZggrCH0FHUz6LyG94SK2rG1XjseyxRkA8JQOyYPbC+eD4+QPkxN5FFvdDsNy2ytOujOUyop0YdB0wE9dbAtHbel4zb9bNPPj5F+tqXjNna3sfvPjN2vKh1bXyodW19ROrYYllgTLLH+ytLRh7oDS7MJGAVk8DJQb4RlYwyiwCez+2jCXj+yUxR6lSqy0VuvIkdS4hMBi7xYUpWdyGipLoQ36DvHvkneFzpwNgWIjBigVgDVLXpVMBdYk+LxkzCYBxTHKBDQTRZ2f5KCVDpmcn8rZgkiL8yAQwKFUOLeqwQfC8CdxATLP6BA+6BTAOo/cY/TWOsP7QezIUp8hBKzw1tPCIz5Yv/X3fSUwMCcY2Bn2tYPPC6g98x5BMsIcRtr+CpK0G2pvi3Vt+l+m+5/jHS/LdW3sbuN3X9m7H5FqW6qoYdLdejw5FLdxac3WVFLvULn+u4VO4WK4YDcm0mPanV/WYPjE8YCGoNUHzM4hxJ/X7tyP8Mnti/wgOieecje1gfGbP3Ir2m16KDAXIBDolixpO1a87z3bnWk2r0L/Pvd4jicXlCYEwaVw2R39FR2el/jcVADNATLp4tI3tA5sjHoegOM4VOrOmSxA+ufDsyKpUaGSgKMBQ2cRFybjVRjlR5Nf5QyPneO/rCAxQzTZHYYxI3xS2oGFmNYlPykqHeN/HBNPpDrPAnv/7gsmtADsmxS36OzQX8GnK6IaOmn73NXOcMKXs++5jDLrIT3Dhprk51gtwZ7KXgCywv9OM2zt+9Hz9kU61bCjUxhySwCXGhA5J2CixAu9vNHS3AQpapEZlN96rNfeXgH45BNQhCYfYjOhGAXA6OEY0gYQ0B4UikOEgQqOOryWW4dX1yLEHNp9Zz3LsTCLmhol1fGPae8SQuM0nHM2ofIZgcBwlmA+R/7GBFpvcgu4lwuXpLrW5n4T07N1tRsoqaer3ChVXuhw5F5AAZIgoeKtPXNkxtgKNHD1Ri0INVVHlATho/qI1debrVv5qNCz0Z6VT4+RO9nASTl6jCm0YspyKmhzwbMm0mpxH8ZQ9fBMLiYZhBF38zWDU5qU0TYjXqJJVtPaQd4goX4O4LAiLQz8TGmeKpwpN5soZD8jSwLMf8bLMB99ltFZmq+gEyMPX3pqW/mGSe0cUJbY4Ay/OtEh45l4SkieaP0KV10gP2l/QkJDKMl3NO0NqI6kd+lMZgaPGCVqKh4T3/ZWwKc+cToAvYu+gAMY4VePIQG35mhhdmuoqx8b2FVg+v8hhKS7IreNL/FHVJMvH83eVHi/nIL5iQKF382Sj+AJH8f3P2LEG+LND8i0piaGbcyh8u3+Ryuv2Zh+16bf9t7bTaxZobqc4mlQ4WPH/dDrU8kubVZvJZB9KVZD6xvOeM9kZmAn3CVcgEZDxbXy3ejlAnlmqCs4c0CQZtVseApri12ELnknJA+1oerhXnJyjSBPpAWFNiNj4MQ6NHtlHxmToCsFy6IG/hdZebhHgmQx6OpqLH3gonIg7DHvQN8rByufZRmE+EM/PAU/ZAd5GACRf18nkUwG+J+NmccIOsLiOMHyst0YjRH3bUIkpYWxag8SyCUoQg1WkUnc3UyMW/WKAHLF+YCXFHmJgj30tJZ5aUgQxES8mG/6rLwS7QBzeyZCGN0EsjqAs98Lmd4NxitUQRikbnzJpPprhmkdrEvHtlenoqvObW6TctRaMdlPKzdS8TfgClDkb+8Ld/CoY2w4n1tFYe8W94I+pZ3v6X5S2du090Yt1aRrUyvdPXuwoW1srsAo/bolW8mEi819GHPuzvch8MV972lz5HTixUul4tp2oQAPeNnv8CiByV6NjSv+XnOvuY1chulyreVo8VyRwmB7xPlD5Do/hJ66Z1CYlNfMLem7JF+qVA+cO2eG+4+6BF69/HRvuW9nNMT3Ictctpcb24l/AYa8eee9QH+IkrG2p2hE7XfWflWMfTRdPPie1PtaT6AOaDb/wFaTJXE
sidebar_class_name: "post 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 'Handle status request from client' (update-managed-client-status)"
---
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"}>Handle status request from client</h1>
<MethodEndpoint method={"post"} path={"/managed-clients/{id}/status"}></MethodEndpoint>
Update a status detail passed in from the client
## 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={{"name":"id","in":"path","description":"ID of the Managed Client Status to update","required":true,"schema":{"type":"string","example":"aClientId"}}}></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={"body"} required={true} schemaName={"object"} qualifierMessage={undefined} schema={{"description":"ManagedClientStatus body information","type":"object","example":{"alertKey":"","id":"5678","clusterId":"1234","ccg_etag":"ccg_etag123xyz456","ccg_pin":"NONE","cookbook_etag":"20210420125956-20210511144538","hostname":"megapod-useast1-secret-hostname.sailpoint.com","internal_ip":"127.0.0.1","lastSeen":"1620843964604","sinceSeen":"14708","sinceSeenMillis":"14708","localDev":false,"stacktrace":"","state":null,"status":"NORMAL","uuid":null,"product":"idn","va_version":null,"platform_version":"2","os_version":"2345.3.1","os_type":"flatcar","hypervisor":"unknown"}}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"ManagedClientStatusEnum"} qualifierMessage={"**Possible values:** [`NORMAL`, `UNDEFINED`, `NOT_CONFIGURED`, `CONFIGURING`, `WARNING`, `ERROR`, `FAILED`]"} schema={{"type":"string","enum":["NORMAL","UNDEFINED","NOT_CONFIGURED","CONFIGURING","WARNING","ERROR","FAILED"],"title":"ManagedClientStatusEnum","description":"status of the Managed Client"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"ManagedClientType"} qualifierMessage={"**Possible values:** [`CCG`, `VA`, `INTERNAL`, `IIQ_HARVESTER`, `null`]"} schema={{"description":"type of the Managed Client","type":"string","example":"CCG","nullable":true,"enum":["CCG","VA","INTERNAL","IIQ_HARVESTER",null],"title":"ManagedClientType"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"timestamp on the Client Status update","type":"string","format":"date-time","example":"2020-01-01T00:00:00.000000Z"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
Responds with the updated Managed Client Status.
</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={"body"} required={true} schemaName={"object"} qualifierMessage={undefined} schema={{"description":"ManagedClientStatus body information","type":"object","example":{"body":{"id":"1528","clientId":"1528","clusterId":"1533","orgType":"test","vaDownloadUrl":"https://sptcbu-va-images.s3.amazonaws.com/va-latest.zip","clusterJobCount":1,"configuration":{"clusterType":"sqsCluster","clusterExternalId":"2c91808876dd79120176f758af765c58","debug":"false","failureThreshold":"0","gmtOffset":"-6","scheduleUpgrade":"false","va_version":"va-megapod-useast1-595-1627543540","jobType":"VA_UPGRADE","cookbook":"va-megapod-useast1-595-1627543540"},"connectorServices":[{"id":"540696","name":"EndToEnd-ADSource","connector_host":"host.example.com","connector_port":"389","connector_(boolean)useSSL":false,"connectorFileUploadHistory":null},{"id":"540698","name":"EndToEnd-AzureADSource","connector_host":null,"connector_port":null,"connector_(boolean)useSSL":null,"connectorFileUploadHistory":null},{"id":"540710","name":"EndToEnd-OpenLDAP","connector_host":"10.0.2.64","connector_port":"389","connector_(boolean)useSSL":false,"connectorFileUploadHistory":null},{"id":"540713","name":"Dynamic-ADSource","connector_host":"host.example.com","connector_port":"389","connector_(boolean)useSSL":false,"connectorFileUploadHistory":null},{"id":"540716","name":"EndToEnd-JdbcADSource","connector_host":"10.0.5.187","connector_port":"389","connector_(boolean)useSSL":false,"connectorFileUploadHistory":null},{"id":"540717","name":"EndToEnd-JdbcSource","connector_host":null,"connector_port":null,"connector_(boolean)useSSL":null,"connectorFileUploadHistory":[{"serviceId":"540717","date":"2021-02-05T22:58:15Z","file":"temp7081703651350031905mysql-connector-java-8.0.11.jar"}]}],"jobs":[{"uuid":"872b622f-5ab5-4836-9172-e3bb77f05b2c","cookbook":"872b622f-5ab5-4836-9172-e3bb77f05b2c","state":"FINISHED","type":"VA_UPGRADE","targetId":"1528","managedProcessConfiguration":{"charon":{"version":"345","path":"sailpoint/charon","description":null,"dependencies":null},"ccg":{"version":"415_583_79.0.0","path":"sailpoint/ccg","description":null,"dependencies":null},"toolbox":{"version":"6","path":"sailpoint/toolbox","description":null,"dependencies":null},"fluent":{"version":"50","path":"fluent/va","description":null,"dependencies":null},"va_agent":{"version":"89","path":"sailpoint/va_agent","description":null,"dependencies":null}}}],"queue":{"name":"megapod-useast1-denali-lwt-cluster-1533","region":"us-east-1"},"maintenance":{"window":"true","windowStartTime":"2021-07-29T00:00:00Z","windowClusterTime":"2021-07-29T01:35:24Z","windowFinishTime":"2021-07-29T04:00:00Z"}}}}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"ManagedClientStatusEnum"} qualifierMessage={"**Possible values:** [`NORMAL`, `UNDEFINED`, `NOT_CONFIGURED`, `CONFIGURING`, `WARNING`, `ERROR`, `FAILED`]"} schema={{"type":"string","enum":["NORMAL","UNDEFINED","NOT_CONFIGURED","CONFIGURING","WARNING","ERROR","FAILED"],"title":"ManagedClientStatusEnum","description":"status of the Managed Client"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"ManagedClientType"} qualifierMessage={"**Possible values:** [`CCG`, `VA`, `INTERNAL`, `IIQ_HARVESTER`, `null`]"} schema={{"description":"type of the Managed Client","type":"string","example":"CCG","nullable":true,"enum":["CCG","VA","INTERNAL","IIQ_HARVESTER",null],"title":"ManagedClientType"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"timestamp on the Client Status update","type":"string","format":"date-time","example":"2020-01-01T00:00:00.000000Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"body\": {\n \"body\": {\n \"id\": \"1528\",\n \"clientId\": \"1528\",\n \"clusterId\": \"1533\",\n \"orgType\": \"test\",\n \"vaDownloadUrl\": \"https://sptcbu-va-images.s3.amazonaws.com/va-latest.zip\",\n \"clusterJobCount\": 1,\n \"configuration\": {\n \"clusterType\": \"sqsCluster\",\n \"clusterExternalId\": \"2c91808876dd79120176f758af765c58\",\n \"debug\": \"false\",\n \"failureThreshold\": \"0\",\n \"gmtOffset\": \"-6\",\n \"scheduleUpgrade\": \"false\",\n \"va_version\": \"va-megapod-useast1-595-1627543540\",\n \"jobType\": \"VA_UPGRADE\",\n \"cookbook\": \"va-megapod-useast1-595-1627543540\"\n },\n \"connectorServices\": [\n {\n \"id\": \"540696\",\n \"name\": \"EndToEnd-ADSource\",\n \"connector_host\": \"host.example.com\",\n \"connector_port\": \"389\",\n \"connector_(boolean)useSSL\": false,\n \"connectorFileUploadHistory\": null\n },\n {\n \"id\": \"540698\",\n \"name\": \"EndToEnd-AzureADSource\",\n \"connector_host\": null,\n \"connector_port\": null,\n \"connector_(boolean)useSSL\": null,\n \"connectorFileUploadHistory\": null\n },\n {\n \"id\": \"540710\",\n \"name\": \"EndToEnd-OpenLDAP\",\n \"connector_host\": \"10.0.2.64\",\n \"connector_port\": \"389\",\n \"connector_(boolean)useSSL\": false,\n \"connectorFileUploadHistory\": null\n },\n {\n \"id\": \"540713\",\n \"name\": \"Dynamic-ADSource\",\n \"connector_host\": \"host.example.com\",\n \"connector_port\": \"389\",\n \"connector_(boolean)useSSL\": false,\n \"connectorFileUploadHistory\": null\n },\n {\n \"id\": \"540716\",\n \"name\": \"EndToEnd-JdbcADSource\",\n \"connector_host\": \"10.0.5.187\",\n \"connector_port\": \"389\",\n \"connector_(boolean)useSSL\": false,\n \"connectorFileUploadHistory\": null\n },\n {\n \"id\": \"540717\",\n \"name\": \"EndToEnd-JdbcSource\",\n \"connector_host\": null,\n \"connector_port\": null,\n \"connector_(boolean)useSSL\": null,\n \"connectorFileUploadHistory\": [\n {\n \"serviceId\": \"540717\",\n \"date\": \"2021-02-05T22:58:15Z\",\n \"file\": \"temp7081703651350031905mysql-connector-java-8.0.11.jar\"\n }\n ]\n }\n ],\n \"jobs\": [\n {\n \"uuid\": \"872b622f-5ab5-4836-9172-e3bb77f05b2c\",\n \"cookbook\": \"872b622f-5ab5-4836-9172-e3bb77f05b2c\",\n \"state\": \"FINISHED\",\n \"type\": \"VA_UPGRADE\",\n \"targetId\": \"1528\",\n \"managedProcessConfiguration\": {\n \"charon\": {\n \"version\": \"345\",\n \"path\": \"sailpoint/charon\",\n \"description\": null,\n \"dependencies\": null\n },\n \"ccg\": {\n \"version\": \"415_583_79.0.0\",\n \"path\": \"sailpoint/ccg\",\n \"description\": null,\n \"dependencies\": null\n },\n \"toolbox\": {\n \"version\": \"6\",\n \"path\": \"sailpoint/toolbox\",\n \"description\": null,\n \"dependencies\": null\n },\n \"fluent\": {\n \"version\": \"50\",\n \"path\": \"fluent/va\",\n \"description\": null,\n \"dependencies\": null\n },\n \"va_agent\": {\n \"version\": \"89\",\n \"path\": \"sailpoint/va_agent\",\n \"description\": null,\n \"dependencies\": null\n }\n }\n }\n ],\n \"queue\": {\n \"name\": \"megapod-useast1-denali-lwt-cluster-1533\",\n \"region\": \"us-east-1\"\n },\n \"maintenance\": {\n \"window\": \"true\",\n \"windowStartTime\": \"2021-07-29T00:00:00Z\",\n \"windowClusterTime\": \"2021-07-29T01:35:24Z\",\n \"windowFinishTime\": \"2021-07-29T04:00:00Z\"\n }\n }\n },\n \"status\": \"NORMAL\",\n \"type\": \"CCG\",\n \"timestamp\": \"2020-01-01T00:00:00.000000Z\"\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>