mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
96 lines
36 KiB
Plaintext
96 lines
36 KiB
Plaintext
---
|
|
id: test-source-connection
|
|
sidebar_label: Check connection for source connector.
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXFtz2zYW/isY7kOTjHW1bEd62VFsZ9cd32rZmwcns4VISEJLASwvSVSP//t+5wCkqIuTNO1s24z84MgkeO6XD0dEHgKbqFTm2pqzKBgEucrykS3SUB1bY1RIN4K9IJfTLBjcB+5WFrzbCyKVhalOeMEguJ3pTCgTJVabXLyXsY4kaIl8JnP8UiK0ZqKnRaoiEeKXMrmWcSZkqtxqIU0kPug4FklKIsULIQs8iHUhKOFWPmNCGYsgNJOYaNAbL2o3ziKRSCxNZCrnKldp860Zitz+rIyjcXXzr/8OTy7OLpm+TXW+EJA9Vb8UmqTLrQglxMhJo+H1WRPqZyosaCFM8BDcZSqFcXL1MR+CAplFR2bg2DdCZzabDubSyKkK3j3CWJU0GZPQZDISE7QNbuCvUnriFs7UXAaDhyBfJHwvT7WZBo97QSllMMjTQm06QYmzE2EnbA/nKxJffZTzJCZKoZrsK9Vtd6Jxv3cUHvQ73YODTrtzMJbt8PCoH5CwqcoSazK4GSJ02236Z5MRVhVxTswgbvgzBBRhFTJkxZqzKqM4F5QMxCS1c6FzkjEki5qceMkkicnpoNP6KSOGD5s2seOfQJFCU+es2iiXeZGJG087WDdOeUPMbaRiMYEwNXlZh70qSqVTAsnAcZmQdtB0XZ2MJHfxmmtnLx1tOm5dlKWPHMEVF3XDfudl++XB4cvwoNsPD9sdfArl4aTfDjv7nf2AHCSjKxMvXBQ8ljH0ObaXWPUJxlcno8bwpHFLSt/7aO7zz7ttPDO29zauyhRzLhZ3x8enoxGuvB6end/dnG4rGxDFOc4LNlMyRoiwP1Zjd0luQxYVyyRT0QXKh66LhFqkpirdsASxhZBjlRLbOT+m4NUoE1mCKBTkfKyhEpMqrg2wyoo4nXa7vUWSSOVSx9m2QN0UIbJhMSd2FPxSm4yZusTabpC3hi3GyeAWoEhVZCIF4aGDl54EqEVtAQuBwIb9ako9BFh0ez56bdOzH0Yqfa8RI4MJCjVW1a48BFgkrm2KfIUVmpent+L4/Eb8BwXOqddrtpv77f1Ov9lDBWmD6YgNLNOFpzLy8RPcFMa4wHEED9oHoPlvm+FzMLy7vboY3p5dXSI2seTSVculLDW5tlBcZ1p/tHFmEHomVJ1GtQyPLHWoVoqRShrddrftWoFbWgnb2QuuRmKYhjOdw9NocST3xclhD8uvXHdF+RgtslwhL4ILHaY2s5NcvNEmsh8yQWwQiijLXXHTFdCDOFArmOnpDJF3YvNLldet+1KgfsVojBTcrwodR+JWs2na/Va32yJpRftwsN8TwwvRgEnb1D8qlY5jjYih/nVq5DimjuLd7IP9OrVo9AiZK2LYaXX6RLMjOoPe0aDTE9cXwaP72Qt623qE4yBO0xSSNlCXYRmD/qonPsqZjRjbiPuvNgwDflcrWK3ELhWPUe0/Xxpfa6Ma0xQ5CAkVixziQcIi73VE7ptbFAJHssxMXrdao2CJZke8khH0dfode2VgpjyV3CfPvqBF3BmN50X5COAOd6wn2KojJceH7X63NznsSdl92escHYz7E7m/3+4f9PvEfQ5vAo/US5NMU7nYYP0vZVSqQxFb4CD9KwyCegHbswDMHI8g1Odbq9yqD5jGF9ifqppbW6np5RWEs/aEFK+Or0XvCDFvpgVfl9M1I5jGHXUHU8QxhXRVkx3hq1RPtflUvzo5fT28O7/FlZvTH+5OR/hEtDaa1tAgWiMKS8v9Y2Y/sMRegQ8SXUTFMAfqrXjhqb6AQtJXeL9Qu78yLgyIrYlE3ccTnvuWJ+qkHXiqp1LoQKl4ppuquSfGdG0u83AmxhKJXLaFF8MwVEneOPeWfEEtJlLp86YYRpEmJWVMoBxE8fwChISMIkpdR2BSUJFjKGeLXBgLiL6GM5emXPXGEq6d151CyQHJPx8nQ9RXCMdq1rOwihYvovcPZHaWW5XutmY0NukC7TekjUaMbUdo0xQWFmPoptGHfTkid2UoPKZcV1UsKoGlWlzuLpwwJ7nle6Essi/Iu+sY5afBqlU33iuffBkhaleN2Bulm3xF8nCbH/arKneViS+wWYqjXe7ucneXu1+Yu+s3yz2kv8vQp7MJfe6MHy1Q89yAPilHj7Hl/OFXt9l0jtwjXOch0vdvbv3ggmYrHxPa+P+B+Mi18g3hh5U/3PUxwY/KWSu+IAH9qIc0mKASqWjAci8lDpYocX+TG3YaY40ANVsgIqpmKha24CFR6jC9kNkeNjwqM9/lYiZRH2VIONVVQDeDavAQaockd0hy14123ejb6UY7JLnL3V3u/j1z95NIspKKs8XjpKyYz2kiyZHm75O2UmDB8iuUKuXYVetohYiJCmMFq8ghGHc7487kKFS9SPaiw/3+pBseduXBUeeoM+51j4J6r79f5nGVZKs5VfO386Mb77vhZmEQXFlubbQ6/oN5UzWhskalp8LN/K3Q47slduxtYsdLm0M3EAZ2TJ8YL97dnBN9sGbyZDc3DaekZdO5rygJUlIMw9I6y3fQcQcdd+1n136+mfazg4673N3l7t8zd38TdOx9Djr2fgN07AmCWBOCWH8mdIyAOwiaTeAU6BAWMK8h2JhAFXzy00ef9rlMpyqvgN4Kiuz2t7zLZK24kGZRgqVsZRJpluai8oa1c1qblmuxQIopSqQRqFoa6JaiSs8VYVJ6by3Wc815TAqBbrpoDCc5tHI5U8ZbxUWbMC4gIReF2NLs1SLGNMJJTQj+gQLPQaco1H/gjNN763fNg8UNaXxOGovTj6FSlPPV/Pdg21sCZxA+pXLh34F44nUBNzOXBtsI9TFx5auCoDuovoPqu3a/a/ffRrvfQfVd7u5y9++Zu78Bqns09DRUx4IvhupY22yLCku9puD6vyN2ThUvAYe3sCFj9WiJwRlXIJRIoMTyoJWPQQyCloPrWeuhPAnx2Kres2/x28/l2Qp3JMVtDpysRRqDxCzPk2zQaj3AhXDdY1MmuunOieQLYz80QztvjWG3LSWJ3kB16UcL6NyH33002eipprh2RZCJOxewmhTBcAW/dPBJysa/f7+AgsKR2aOXtH2M8WWImGCD8V3Gq5scUxv6Qa+7NH78/bo4Qk/oss18n+SG9QKSrqlIKrxbHqEZERp33DcO0iw7DH0P0N1gdkXLuuKVkim2Cu7VmGffv7l9LqaEQbkGFBnBX6Vp04AsukaIcI0blq+J0EPcdlJbTN2RouHKiziUU2ISQ2Hx1oyUEvdn3giXKP43qNZs0uHydBKeeves9E6k3quY+mJzaUkKPB2ZFizUkivPPeceyJsFbfBxzlebb01DnOjUBXvGa7yKvPcT90mpl6zp9bVC/KOk1nDUGkwte74mhTPtfehe7K6f4iJrfTVzR69Ro0c7K1whqusykCW8HKuvT4Wl175ajhV6DaK3Ksdb82am0WBXHxOunokM/TGOxJkIZ9Zm6p9CUOhQGtxPC2TRV4v1gZg2OCMa3XZNpIZj2dANwEWW7xyJYVwwyTG1a0Yr1g1OOCV/ZM8i53/kc00/rujMl+/RVWllZMPsq2Umhg1i2HA1IPPy+9Mxz/kUCunAdcAFwPHS/1wJvKC1uudoba3qTL7Fz1BrCCEqU8mSgftjsCxw/pPgG7S6WoMyTGi7eqGMjgF6WtS5VoxVzgnWLbgpb2zRMNfs5uStvu2kJvpX05c0Hi7HKXRe6I+u0k9Ukr9O3f2TKt6u0nyLlcbjXwo3Zus3CvUgf+Xx2uZ4j+bPM4XfuMu5ylAbG5nlweg6oSSWOUU1Z3U404oHA4mSOWG/PYosO+dMTPw5r8wRmqaKDpVBZImtnI5Bj0fXJWfJCeOAJfmV/s4K/yKFRUhio6ma4g2dnQzhFtqn0Su8uPeT9Ru2ETxzzefET0pnA3TN54Whs9gQu5gLiZD6TEREOgsLV7j8xsCpYBn6VU+VWUyhRio0eceSzrOryfJQ4Bfygt8zP3CG6cmL/vT2UpEbFXNk0rpV2P452oi2xkzFCe0UUXUVHWJecrg4u92gCGLGf8th02nLP5S1aC2IvK/OC+43O812g7cLuE4bL+xta8SPaXtVPw5NxXH9sHNzPSoflpP3b/z8v294tFNpJTR2IzMWbufk9q/3/gA/uX1QO8tfWY8+r29isS2a8THX++DhgeY2tKt7pMu/FIqGAvfvlhs23ugiVlZPaz7pkGc3XqHn/M3Ttv8WYKtW5cjRLJbThgAff1Y0pKg0w4YewvMsiQVzt920qfbgxvcxtBWsJgDXVzR3Ywi1DVb4D7ACCuf/AMnqOzE=
|
|
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 'Check connection for source connector.' (test-source-connection)"
|
|
---
|
|
|
|
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"}>Check connection for source connector.</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/sources/{sourceId}/connector/check-connection"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter.
|
|
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":"sourceId","schema":{"type":"string"},"required":true,"description":"The ID of the Source.","example":"cef3ee201db947c5912551015ba0c679"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
The result of checking connection to the source connector with response from it.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the source","example":"ODS-AD-Test [source-999999]","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SUCCESS`, `FAILURE`]"} schema={{"type":"string","enum":["SUCCESS","FAILURE"],"description":"The status of the health check.","example":"SUCCESS","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"elapsedMillis"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of milliseconds spent on the entire request.","example":1000,"readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"details"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"The document contains the results of the health check.\nThe schema of this document depends on the type of source used.\n","readOnly":true,"example":{"useTLSForIQService":false,"IQService":{"TLS Port":0,".NET CLR Version":"4.0.30319.42000","SecondaryServiceStatus":"Running","Port":5050,"Host":"AUTOMATION-AD","Name":"IQService","IQServiceStatus":"Running","SecondaryService":"IQService-Instance1-Secondary","Version":"IQService Sep-2020","secondaryPort":5051,"OS Architecture":"AMD64","Operating System":"Microsoft Windows Server 2012 R2 Standard","highestDotNetVersion":"4.8 or later","Build Time":"09/22/2020 06:34 AM -0500"},"IQServiceClientAuthEnabled":false,"requestProcessedOn":"1/19/2021 1:47:14 PM"}}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"ODS-AD-Test [source-999999]\",\n \"status\": \"SUCCESS\",\n \"elapsedMillis\": 1000,\n \"details\": {\n \"useTLSForIQService\": false,\n \"IQService\": {\n \"TLS Port\": 0,\n \".NET CLR Version\": \"4.0.30319.42000\",\n \"SecondaryServiceStatus\": \"Running\",\n \"Port\": 5050,\n \"Host\": \"AUTOMATION-AD\",\n \"Name\": \"IQService\",\n \"IQServiceStatus\": \"Running\",\n \"SecondaryService\": \"IQService-Instance1-Secondary\",\n \"Version\": \"IQService Sep-2020\",\n \"secondaryPort\": 5051,\n \"OS Architecture\": \"AMD64\",\n \"Operating System\": \"Microsoft Windows Server 2012 R2 Standard\",\n \"highestDotNetVersion\": \"4.8 or later\",\n \"Build Time\": \"09/22/2020 06:34 AM -0500\"\n },\n \"IQServiceClientAuthEnabled\": false,\n \"requestProcessedOn\": \"1/19/2021 1:47:14 PM\"\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={"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> |