mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
test embbeding
This commit is contained in:
83
docs/api/beta/delete-non-employee-source.api.mdx
Normal file
83
docs/api/beta/delete-non-employee-source.api.mdx
Normal file
@@ -0,0 +1,83 @@
|
||||
---
|
||||
id: delete-non-employee-source
|
||||
sidebar_label: Delete Non-Employee Source
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztWttu2zoW/RVC83DawrIdx22avAzcNB3kIL1MLuhDGqC0RNtsJVJDSmk9Qf591t6U5FvadHKKmXMKvyS2RG6ufeXaNG8iWygnS23NcRodRKnKVKneWHOUF5mdK3VmK5eoqBN5lVROl/Po4PImuvDKHVpTqq/lqCpneBbp1BwYleUHuTRyqqKr26tOVMqpp5cQGDcSxYmeqGSeZEq85qG5MmWEwanyidMFYQGS85n2wql/VcqX4ovOMhGwCSkMpKlGmmeAXSAspJM5RjjPGDVJKSTQdSKDF/gWxkLR9cWCloLf0JraKVijdJXqROqrxFo0fZDs7zzvPx8/U5OddLir+jv4NJb9RA33+vv9IVkpmalcRgc3UTkveMnSaTONbskaTvnCGq88vR9gPP6t4nhjRUJmNaWIhTapTmSpvChnamEK6YWvkkR5P6kyMa5Keu2UgLnMYnppxZgmlZUzKoWsWkhA0I1uO9Gw399EcJhpmn7knHXAcNoKmKygGNt0Titqcy0znZL565VJpCyKjKBDZO+TJ7k3m5ax408qKclvjmKw1MEuqSqlzg5tqjatuO62V9qoeOqkJoSKISeYKCDxWqeYIXILywSRwgYVeBwBXjgWlujuiBcyhb5Bv8NaGZipdDL5DFmUH/cBujAa80UzRehUTADqG8uqPSXHz/r7g+Hk2VDKwfPhzt7T8f5E7u7295/u79PqOfyMHPFLa0vn5Hxj6X8oo5xORGYTeOTfMIhTErZnALw4puhS5f5+H7CMH7D/OfQKY1s1a7yCSkMHufri8J0Y7olMmmnFz+V0zQgmvjijFK2yTI7pEaUdNA+C3zo91eYuKMpUOdWWl0evRhcn53hyevTPi6MzfCJZGwVlZJqMAlTEwsx+YcS1ApxXqDBJqdKueFJLfQKFpPHLA3X45ucexkRsTWSVlZhRr37HjGXRYuJsvpJKSaij4pHuqm4HWYtnuSyTmRhLjwk2pO6TEXK+KOOT2pJPxEzJVLnHXTFKU01KykwgGyEU8+eU/jJNF7k/qZDKAKPLmUXRMLbUoW4ufLEw5ao3kAS65BEny06h5ADy++NklJQVwLGay1nYRksNsal4aW25VXTn61VwbkqZQAuZZXOY0TlYmAuiLn1bCDXZHntSM66tWLe3C7W43L0OYF6Wlt8lsvI/kHfvMpSfmFVrX1yrOvk81eFQjdgbjZvqioSXpDZPrke17moSX0y0ytJt7m5zd5u7P5i76y9Pa9ZTv2Xqs7NJfS6MBJe1jjfPDerTMqxmENOb2pEdAYPUFOn39+dI7M/K0Hj1tSAu+RP5UdjKN8CPWn+E52OiH62zVnxBANmOQYMJKpFKDxj3AjEbKphqd3O1V9aNNQLU3EERUTWdmNtKSJjMVcYQEuk7IrXKm99KMZOoj5IZbKiAtKpJ48JqU26Z5JZJbnej7W706+xGWya5zd1t7v41c/e7TLJFxdlS8yRf5bl08xBp9XvSVgoMaM/fRJty7Kp1tkLCRMuxolXmEI0HO+OdyV6ihqkcps929yeD5NlAPt3b2dsZDwd70fJef7nI4zbJVnNqyd/Bj2xikLhr8LjKILh8aW26evwH8zo1obJGpaflzbA5THrVcsfB/iZ3PLeWDn7nDUPyKxzSLGxENQ1jcxrrmrEYIMUUddEIlCoNXBRKOleQ4hA0ItO55uQlLSDXzePRpIQqIVHWT0LxPckqIORKkFlizRaBpaGkmhDngwRmsFNU55/ITmsX/SEmL05J4xPSWBx9TZSiRG+Z+9O7znePAd5RjTgLDv7GQW/odqRBAKAhCDWr5Z1bfr7l59s9frvH/xp7/Jafb3N3m7t/zdz9L/h5zYa+zc8x4If5OcZ2+6LlUq8ouP7nNJ1TpUbA4S1sklSOj5sbDs68AqG0uNvBFyXoykbUW75HEYe7Eb5301ySuOVLH0QSA77KZZg0K8vCH/R6N3Ab3HXblYXuoprBc+Xc2C/dxOa9MWx1Rxmi+wIh5WiAGL07rtuMLhvaaYrlUPhYeDA7q0ZRC/PzEfF3JdNND/LnHFqIIKYjEPd1XPFjQCzQVPzmeXSX42hDP+h14bLbP65LEPQNXe4y33dXw3gBpGsqkgpXizs6Z8TAw+obN3UWuwp1bYONxd7SsIF4oaRDexB+yHj0+/vzx2JKvJPzvvJEeZWmRgGZ8w4hwnVt1Bzq0yTeapytpjMGPlr52YTySEwyKCw+mDOlxOVxbYQ3KPinqNBsUpqkuCjQrKtHjXdSda0y2gu7C0tS4OnU9GChnlyZ95j3PW4QtMHHnJ92P5hYvNRUjjTt3zSmVpH7PXFZNHrJJb0eCuJvjbQ4SItZmn+8hiKY9jIJ13ASJDOJkJlnaz148SAvXpJH3RSekNR1DGSJGsfqj11J47UH41iRF5O8VRwfzPuZxqa6Ok2EGiY89sQsFccimVnr1d+FoNChNLicVsiiB8P6QovGnBHxoL8EKQ5LxjoGRWR8J0gME4JJjmmLZoZiQd5MGlLyI3sWOf8RDXQqPq7ozI8vsZPSyNQm/sGYacGYFoxDDfA1/rBRUWAht0kHrgMhAA4X/udKUANdqntB1p1VncX3eA7fdANUluKLg/DlYFHg6k+CX9DodgzKMDHs9uc/fBe1LNqtVozVnA2sW3ATb2axSa7ZLeBtz6Zo4/yz6UsajxZHKG9NNv/ZVfobleTPU3f/TxVvW2l+xUpTc14KN162bg6Wg/xFzdc2j/TozHmm8BdvOVeZXqN54XaMWcyyoCKTJUU1Z3Uy04oPAwolS+J+HYosm3Mmom+n9EfLx4KmDmOQth6cVI51Bnl8XN2sLDlhArEkv9J3X3FHQmslMzSXqiveoz8zCdxCvRlduMC7T7Zu0s7gmXfkWPGycTZIV55XBqtRXla5kAipeyIi1T6pQuFCq2ZUYwvL1K+d1WQxhRqp0OUuxeX+7YTOmdHCLjn+nrXgd18fMsP05MX69vZCkVOVcWTSuFXafp9sRFs8U1lB3SGqLgiYWlrh9fH5hkQIM/Udc+umvXqS79FYCKH2KITPbnen24+5XcDzwvoS/ewKfL6+vnIVvr1dvxKJN4sT9gdcg683DmL8vYKOrAhOFTqQ0PldRnd1fph60F6QRzMxgwY09uaGTjioF7qlx0BC7fPl1aLN4fYQFqbPaDQnyHn1HZUendY37B+L5Xv3d+JuDuTMfNGLR/j4WVEL38JFuwvAfNLCYMLrcBazNHHj1wpqmtr++OXRydH5URQ4yF1bcP0BuqPI/AezDENI
|
||||
sidebar_class_name: "delete 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 'Delete Non-Employee Source' (delete-non-employee-source)"
|
||||
---
|
||||
|
||||
import ApiTabs from "@theme/ApiTabs";
|
||||
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
||||
import MimeTabs from "@theme/MimeTabs";
|
||||
import ParamsItem from "@theme/ParamsItem";
|
||||
import ResponseSamples from "@theme/ResponseSamples";
|
||||
import SchemaItem from "@theme/SchemaItem";
|
||||
import SchemaTabs from "@theme/SchemaTabs";
|
||||
import Markdown from "@theme/Markdown";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
<h1 className={"openapi__heading"}>Delete Non-Employee Source</h1>
|
||||
|
||||
<MethodEndpoint method={"delete"} path={"/non-employee-sources/{sourceId}"}></MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
This request will delete a non-employee source.
|
||||
|
||||
## Request
|
||||
|
||||
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"sourceId","description":"Source Id","required":true,"example":"2c91808b6ef1d43e016efba0ce470904","schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||
|
||||
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||
|
||||
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||
|
||||
Client Error - Returned if the request body is invalid.
|
||||
|
||||
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||
|
||||
Generic localized reason for error
|
||||
|
||||
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||
|
||||
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
|
||||
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||
|
||||
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||
|
||||
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||
|
||||
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||
|
||||
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||
|
||||
Generic localized reason for error
|
||||
|
||||
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||
|
||||
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
|
||||
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||
|
||||
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||
|
||||
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||
|
||||
Internal Server Error - Returned if there is an unexpected error.
|
||||
|
||||
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||
|
||||
Generic localized reason for error
|
||||
|
||||
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||
|
||||
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
|
||||
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||
Reference in New Issue
Block a user