developer.sailpoint.com/docs/api/beta/get-source-config.api.mdx

---
id: get-source-config
sidebar_label: Gets source config with language translations
hide_title: true
hide_table_of_contents: true
api: eJztW2tv2zgW/SuE9oPbIraT1G02QTsLN48iRfrYPLYDJEWGlmhbrUxqRSmJJ8h/33MvKVmyk6bNFDszhb84DkVe3vc9l6auA5OqTOax0ftRsBWMVH5kiixU20YP41GwEuRyZIOt08AN2+DTShApG2ZxSouw5MCYL1YUqZA6EpnKi0xbkY+VsLxChExJDE3Go5n6b6FsrqLyeRwJOcxVJlKTFglY0aNbll/IBMt4D5mmyZRmJVKPCjlSIs+ktglLYTtnui9y80VpcRnnY/H+8PV5f+ft/jshi3xssjifitgyG3EGLnIjQpkk2BKj/Q/7HcicykxOFHgiya+DmMRMZT7GI40H+C+O8N2GYzWRwdZ1kE9TGrV5Br6Cm5WgJB9s5Vmh5lV2DPGOSukx3W8BxWTT2R6JAWPqK/usBEoXEzJORNO0wccwpgUX+MgKkiTHxxd68Pu4ffyRl+AjpuFh5oa33+HvmGbDvCtBSB+fJS1O8BHRN50En25uk8LxSEpkq9AXsp0zWkfsD4U24iKWg6SaCzWP4gulV0Scw0RQfaSGskhyWnwG/s6C4OYTqdCmsCd4guDrq6v0p8lAX8BLtQpzuNaOymWcCDP4jP9JCqNzpXNaRJzFIXtH97OlldeLKq0WphlFRB67fZ0pFhW/qImwYoXXQJlXcpImtOrNzqttcgpbi6xfJ8n9dH99ewBHTaEJiMICCDO8JTgimcvGji/2TDaZsfQOHL1s9cMcehc78EsanIq2/94SEf/12nzZIp9tsRyLq1rCgpXCvmxlKlHSqqglSIqXrXriaImrSaIxaZzn6Va3e3l52bEwUGpinXdCM+le2ahbjZwjO0zO185XOxhu/XKmz/IXe7FKotI3/kPhXzI2jqNI6SabYWKKqI8I39XkbBVTA2PApW65BOLX/CJedJk8f8HWv8yb537bvDl6/+5BxrkOaEf+SyzQl/O6lKBNTGLJuRO0NuAzw7yw9Mhz6+WlkYs6Nch3zibBwANsQvQa7kThd5c/0eSGRy1KML+WHjm/wsPSsWpizRWl8/NcXRHZM7jKWR7c3FB2am5ZGXCmkqYFiSURN0yG3CR9MJTR4x/VLUgLbyjVJuokTYyMvmGzWaZybtGygtajbhIBIXN42aDI1YoYysQyX9rkxFvW2JufYnO3TkV7IGLv99aD2ObknuUyt7mbbKvaXFm4vuMpZf7qyVvkWfboW1Jnc8v3PEw0kZk11euJXys4wWqETVkvTvbp2wDqcGavBYst0tRkwAsn+yC6++vxmyNn7jzOOddVmnUlgB7iaW91bbFgnGiPAX6HBtrikMEKvjonyNj+qFflJBfUYwWFZSsCOvLO8ubjsUcYmK+uUir0nR9Xc1SWwQK3VLuJspbgjhsflEDJzW8UHDCI6I8jJ8EQalHRFvM945gV5VT1dHE35KgBZ59FPZGRMjE1hZBQWVZoNq60KyIyyupWLsYSsS1DwEXrLEy76qjtMs2P01TEFt820TfU6D04XHuUwRUhCKsMrhkpAYoXccTuaTLSrcMRw5lqOw3d9lZXO2viFWL20CFZAiEsDPlkJsMvoLUf3c/QiY6xXpRLCAeXcXjLtmpDycHz1c313vB5T8r1f/bWNp4NNofy6dPVzWebm7S79496OpBZJqcLW79WWmVx6BAZB0OGhEueAgZKd4pzNbH328Cj1G/CSB4BlmKW/ky5fAWJ99X2B9HbqMF6OZpTgm6fHBEcLZKECl+Vih3h91k8ivXXcPLO7l7/5OAYI4e7/z7ZPcI3orXQ0/QR2joitwSr8IWxuWSOvQCX0gqLIhUiLXXEE0/1CQSSvveZYV2uLlM0PJMSy2CF3/2WFXXSYpiZSb1p4mQKZYlHcUd1VpAwMTaReTgWAyqYAiak6U/6iL00bx94TT7xSexxR/SjKCYhZVK2VBM5pcwrIyoLsSMwLBDxihsoU+RUieJQNW0xU2XTGrPEfFA3CgUHl+z7/ATIoABzLGY9Citv8Sx6+4Bnp7kmd8c1pbFKp6hCwBzU6k2hxoxLPAoumhArfDoic1kkHl3OizVn0U5Qrze7xM1bx8xObvhZKAv7DXH3IUH6abNo1YML5YOPU6XLRmyN0kw+I/lKyYv9rMpcZeCjqhOiXMbuMnaXsfttsTv/8NCfOvDTiiuOFo+TbDGZSHQs7Gn+OUkrBSaI8tRidhLh27AmWiFiosJYQRM5BIP1tcHacCNUvUj2oudPN4fr4fN1+WxjbWNt0FvfCOq1/nQWx1WQNWOqZm/fNpGKAeIugOMKDeeyuTFRw1tJvZkaUlrj050SN0PnUOmnGXbsLWLHd2hc9gwIAztmc9ixpH9ySEcbQ2zN5ElvrgWjoHWdQz6WOUNK7oTUFVqYJXRcQsdl+VmWn5+m/Cyh4zJ2l7H794zd74KOvfugY+87oGNPEMQaEsT6M6FjBNxB0GwY06+yIiygXp3P/yhShn0us5HKK6DXQJHrm4so8tgY8VbqaQmWbOMkUs/URekNcyc0NyvnYoJ0vzPSaXMMdEteFU8UYVL4j0jiScxxTAKBbjZt9/lnaBczpb9Vu8Q6TApwyEkhMXT2auBjMdxJDQn+gQKfg46QqH/gGae31h86DxaHJPEBSSx2r0KlKOar899nt/22ug/mM0oXR87W7OF3nZlLjTZCXaUufVUQdAnVl1B9We6X5f7nKPdLqL6M3WXs/j1j9zugukdDd0N1TPhmqI65nVVRYak9cq7/O2LnUPEcuIt2JmSsHs0wOOMKuJK/A0o5hO47bgVdh9Zt9zqObrrVNRDrx9theSXH9QSOxSJLAnfNyG51u9ewHCx205Fp3EFCg/HyqTaXfOVooPh21Hwmgp19ZNIEupfpm44O6zrjG4Uu9zFxp3mWjhy3vMP0Vcp0FYlMOoUkwpFZoVtj3rV4GCym6Ctalmd32JUW5INcJ1ly88dlcYTukOU29X11N8wX4HRORBLhE5kLLgBCbK8T8LPtEhfdKuM7P7U5RwTUHYcLM2fFh34iWF+8BUTT1sUrJTN0Ee7WzKM3H48fixHBU04PhSVkrGLqJxBgH+BGnP765Q0SWsQVKTPFaMzC9Rt3dCjcxDCBUsSZPlJKnO57Rb1DXThEIme10yLFuYNWfXpUWjBSFyqhkjl3Hy6OdBda7MrGusdcHrmPiDVdkuPRzpku77/RNWSe40XktlCcpqVcsibXQ5n4R0mt7ai1mZp9PMeFU+1pmMSUPUPEPJGQiWVtPXhzR69do0dNF0aI6jwPpAnPR/NmVVha7cF8NOi1iV6TjzP9cRyj9jaXCZfqhEXpTCKxL8KxMVb9SwhyHQqV01GBSHswW5e0aZsjor2+WmOp7bZsx20gSebvAIGhnTPJAVVyBjLGnalw2P7GlkVe+I1vv//WkJmHT1FwaWZkQvtgnmnDNm3YdnnCev5dPSPHQmyTDJwHnANsz+zPmcAzWsuNjtatmZ/Jd3kNlY8QrDIVm265f7ZmSbC8Ic4PaHY1B6magHh114yu8ntaVNQayiqPEOY1uMhvYlBL5/Tm+K1+CKX6+leTlyTuz05a3utk+qOz9B2Z5K+Td/+kjLfMND9jpvHQmNyNt/U9RN3JX3lMt3jyR0fTY4VPPOVYZRSOHse9mEQopk4oTWROXs1RHY5jxWcGqZI54cMV8iwz4UhEe0/hj86QCY0yzEHYWuBWOYgT0ONT7XJnyQHjwCe/P4X/beHvWBi4JHpQ1REf0cbpEGahFo5u9+LZZ+N7uSNY5gMZVuyUxgbomkwKTe9Tge1iIiRc6h6PiGIbFi5xldfrWQTD0K9aVUYxuRqJ0OFmJpvY90M6jkanWzP8PXvB7tafRUv3WoB/BWEmyKHy745hXhPa30cb3tYeqySlJhJZFwBM1XZ4u3+8QBHEtP8BxGSjrl9kuzQXRKiFcu7ztLPWWW1zS4Hx1NgcbW+N+GuFtrj5pgmr8taX4uad83p2Nv8zvr/nix11Kd2UTuNIhYXrrFxfe+rf9iHNbPHLfLPWNihfBSqbW7RCY+ifVl1f0zEOdXs3NOze2KMWCh7hXsVxb2h8Rd+1Y7Yf/drcHZJ/UXSOUb1OWL4XxG/Zlf3ndwrx6NDr/zH/fjZ7mfEOFsoDUz2tM1CyRi9B0lsm7gyMWXEP3ClZbcnC70gkQ3Vy8XoXQXTzP480lfE=
sidebar_class_name: "get api-method"
info_path: docs/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Gets source config with language translations' (get-source-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"}>Gets source config with language translations</h1>

<MethodEndpoint method={"get"} path={"/sources/{id}/connectors/source-config"}></MethodEndpoint>



Looks up and returns the source config for the requested source id after populating the source config values and applying language translations.
A token with ORG_ADMIN authority is required to call this API.

## 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":"id","schema":{"type":"string"},"required":true,"description":"The Source id"}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"locale","schema":{"type":"string","enum":["de","no","fi","sv","ru","pt","ko","zh-TW","en","it","fr","zh-CN","hu","es","cs","ja","pl","da","nl"]},"description":"The locale to apply to the config. If no viable locale is given, it will default to \"en\""}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

A Connector Detail 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={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The connector name","example":"JDBC"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceConfigXml"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"XML representation of the source config data","example":"<Form connectorName='Active Directory - Direct' directConnect='true' name='Active Directory' status='released' type='SourceConfig' xmlns='http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd'>\n\t<Field defaultValue='true' hidden='true' name='cloudAuthEnabled' type='boolean' value='true'> </Field> </Form>"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceConfig"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSON representation of the source config data","example":{"Form":{"Field":{"_defaultValue":"true","_hidden":"true","_name":"cloudAuthEnabled","_type":"boolean","_value":"true"},"_xmlns":"http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd","_connectorName":"Active Directory - Direct","_directConnect":"true","_name":"Active Directory","_status":"released","_type":"SourceConfig","__text":"\\n\\t"}}}}></SchemaItem><SchemaItem collapsible={false} name={"directConnect"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"true if the source is a direct connect source","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"fileUpload"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Connector config's file upload attribute, false if not there","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"uploadedFiles"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"List of uploaded file strings for the connector","example":[]}}></SchemaItem><SchemaItem collapsible={false} name={"connectorMetadata"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Object containing metadata pertinent to the UI to be used","example":{"supportedUI":"EXTJS"}}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"name\": \"JDBC\",\n  \"sourceConfigXml\": \"<Form connectorName='Active Directory - Direct' directConnect='true' name='Active Directory' status='released' type='SourceConfig' xmlns='http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd'>\\n\\t<Field defaultValue='true' hidden='true' name='cloudAuthEnabled' type='boolean' value='true'> </Field> </Form>\",\n  \"sourceConfig\": {\n    \"Form\": {\n      \"Field\": {\n        \"_defaultValue\": \"true\",\n        \"_hidden\": \"true\",\n        \"_name\": \"cloudAuthEnabled\",\n        \"_type\": \"boolean\",\n        \"_value\": \"true\"\n      },\n      \"_xmlns\": \"http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd\",\n      \"_connectorName\": \"Active Directory - Direct\",\n      \"_directConnect\": \"true\",\n      \"_name\": \"Active Directory\",\n      \"_status\": \"released\",\n      \"_type\": \"SourceConfig\",\n      \"__text\": \"\\\\n\\\\t\"\n    }\n  },\n  \"directConnect\": true,\n  \"fileUpload\": false,\n  \"uploadedFiles\": [],\n  \"connectorMetadata\": {\n    \"supportedUI\": \"EXTJS\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n  \"detailCode\": \"403 Forbidden\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The server understood the request but refuses to authorize it.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Not Found - returned if the request URL refers to a resource or object that does not exist

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n  \"detailCode\": \"404 Not found\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The server did not find a current representation for the target resource.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal Server Error - Returned if there is an unexpected error.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n  \"detailCode\": \"500.0 Internal Fault\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"An internal fault occurred.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>