mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
83 lines
28 KiB
Plaintext
83 lines
28 KiB
Plaintext
---
|
|
id: get-branding-list
|
|
sidebar_label: List of branding items
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW21TGzkS/isq34dNUtgGQ8LClzsHSIot8nK8bD4Q6iLPyLaSseSVZiBeiv9+T7c04xlsAsembndTTlUSmJH6vZ/uluXrlp0qJ3NtzWHa2m2NVP7SSZNqMzrSPm+ttXI58q3d81b5uHWx1kqVT5ye0i7sOR1rL/rvD4Uy6dRqkwun8sIZL6TIQETYoRjE3ULnauI7H81H0xe5/aKMuNL5mLaviXfHr//T339z+FbIIh9bp/OZAGmnfiu0UynWi0Rmmcgjww7E8yopaCFEvG6deeX2rMnV17wPCiS2Ts1uyXzXKZm2Lm6ggVN+ao1XUO261Vtfp/+aWvXvkh1ME+Jhctokp9NMJ2zA7mdPO69bPhmriaSf8tlUgZZ0Ts6wjwnUntvBZ5WQkaeO3JDrII+RE1Vb5XNHdr9tdlq1IB5Wqa9yMs1oY6qGssjy1g0zSIskf/sgynGxYDnqBG+9MEWWyQG9yV2hwEUmROFlkefW7NnMuvt5jdVXcSmzglVJaI8Y4m+gJAZMqiHD+vr21v7OXdwv1ZE2X/4Y7wwUmiw3Ng5eLGVp5KUesfP/GMs5HTGQ7oHMEWM6e+XspJ+miGd/P3feIYbYImTcU2dlbNupaTb7l8cyzuROYifLWPscMSddemRH9uz46H7Ohcsofct9IsPGBu9lXLBIm0MDA03YNjJ7A5Hl6AEhzFuFnu8Vk7j120zBNdc5vywB75DS6ob+rLW2liHFXqYBBuLAOXiyLY4Z/ABXegikUgxfCkgysCnDmTYIAJ0+BkfuwItU5XDYnk0fYJhX2qj2yElNEioWOcFGAYqXmmFkYp0SgSQFKanA6zoN08ESnQ3xUqbQN+i3F5UhEzqZfCHTpfcLdGY09otyi9ApZ8QdbNW2koMX6zu9reGLLSl7P29tbD8f7Azl5ub6zvOdHeIePe2XAHCT9WtllNMJghFlRf8Og6BAwPYsADN/OGYzjQfY/xR6hbWVmlFeQWVrDTXz5d57sbUtMmlGBT+Xo1tGMO2zk+UJQ4TfOY3gXyaKMsWEiuL+wav+2dEpnhwf/Pvs4AQ/Ea2Fyt6nFEopLCEqYmFsr1jiqMCV9MKrDOZQaUc8i1SfQSGJ4l9bqMNvfuZhTBHLEnZE7kt21EkHwKqnUhJqvHiiO6qzJgb0DGmejIGeHhvgQlr+rJ8kapq3j6Iln4kxGgDlnnYEIFMHSAlw7LF/BkKEi5S6gcCwQCor7lBsgbJnc52opi/mpmx6Y44jR3WnUHJA8vvjpJ/kBYRjNetZWEVLFDH6R6XRck3pTmtGY5POTE5lktqoGczoHCxMVRbNgxcRjshdHsBjynUVYtXhkeEu4vF+bvldIgv/gLx7nwF+2qxa9eJSxeTzVCcCGrE3SjdFRMJLUps3x1WVu8rEF0OtsnSVu6vcXeXuA3P39svjOB/Ft9z6bCy2PmcmTmpUPBdaH8fRY2w5zv0eOrHgyDUBg8QW6ZcPp3EYxHr1dUrT3nfsj0IpXzLhlf4IzwfUflTOaviCBGQ7Bg2GQCKV7rLcc4lDk8im2lzk9sq6gUaAmiUtIlDTiZkthITJXGEMSSL9mkit8uanXIwl8FEiI7wPCEhcTdoOTfqqk1x1kqtqtKpGP0w1WnWSq9xd5e7fM3e/2UlWUnG2xD7JF5OJdLMQafE9aSsFFojypF5UKceuut2tEDFR9VitZufQGvQ2BhvD7URtpXIrfbG5M+wlL3ry+fbG9sZgq7fdqtf683keV0nWzKmav4Mf2cRo4i7RxxUGweVza9Pm8V9Bn4sMCdYIeqq+GTaHSS+q3rG3s9g7nlor3kgzKzsk3+ghzdxGhGlYO6G1rlyLBVKMgItGAKo05KJQ0hMFKg5BIzI90Zy8pAXoulm7P8yhSkiUMsgqLtokWQEJGQkyS12zRWBpKKmG1POBAnewI6Dzd+xOJ/PT30d38uKYND4ijcXB10QpSvSqc3++7Hz3EMI7woiT4OA7DnrDtCMNAgADQcCsqu9c9eer/nxV41c1/seo8av+fJW7q9z9e+bu/9Cfx27o7v4cCx7cn2NtZ11UvdQrvpny/27TOVWiBBzewiZJ4fi4uezBua9AKMXrUIQhku4StbrlTRu6NRGa/SBG4TK8Huf51O92u9fwDrxy05FT3QFowUH5zNgrukvRvdxcgjV0KSDkVbxgQ2fMdKEqMOmwTZ2msA0YxwyChcMNHwRoeWXjm/TLO0MzWwDVmMyaQIjHEOLHEHOK+eEnz6s7HDILOkK3M5fd3KfPr5vf0iMQuUOPZeb7Ji+sF3TNpKkeiX8xvyZ2Qo124L5wWWxePGg46y0we0fLeuKlkg5TQPi84skvH06fihG1l5zehafOVmmaB5Ag7xEiDF/98uyeNnFFcbYYjVnwfuPTEUoXMcygsPhoTpQS54fRCG+B68cAYjYpbVKc+7Tr4knpmVRdqoxKXqdxiaerU9OFhbqyse8plzeeA2p3ZTofTVvsa0IdTWWa1kQVeawT59NSL1nT67FC/KOk1g7U2kzNP70lRTDteRJu2yTIWSIhM8/WejTzQK9do0dDE54Q1dsykCWiHM3PtJLSa4+Wo0GvTfSacnw0H8YatbO5TQSoEh6lL0vFoUjG1nr1TyEodCgNzkcFsujRYl0R0zZnRLu3XhOpHVi2dRudIMt3hMQwIZjkgCoxNyIWPZpJQ0p+Ys8i5z9hTk7Fp4bO/PgcBZNWpjbxj5aZGLaJYTtggI/yh3pEgYXcJh0YB0IA7M39z0gQBa1hXqC1FNWZfJf3UGlIICpT8dPd8MvuHODiT4Jf0OpqDSCYGunqUz666hppUVFqGKs8ArhtwUV5+SbcLbsFeasjKKqPfzV9SeP+/KTknclm3xul70CSvw7u/kmIt0KaHxFpYmtL4cZs4wxQD/LQrS2e29HB8ljhX7zlTOUeGhNKuLtPPUydzDSTOcU053Qy1oon/qmSOXV+axRXdsJ5iHaXkh9zHRMaOaxB0np0o3KgM9DriA8YqUwCE9M4RXckQPWzjXPVCaz8nr9ysF86Dg3UZFIY+u4AhCgmQiI87vFuqn1SBBDCdGVUqZnlNq7aVWYkhQ2ZosODhZv4d0M6GsbUWXPiPbzgQx/PhWHI+a3/1lyRY5VxlNG6Zvt9H21ETnussikNdEBQNFOqxuHN4ekCRRAzHnphcLZu1I2bfJfWggiNOiEYNjsY4/gbBdbnmD5rdI+Wfl/idjhdz8/C/9xvjsQyQv1/d0rnVKRVEeaRMPGdt+YTH2aIMTSmh9fXdH5B488NPcbcTsPx+cV8uqHfQCycY/CI+EXx/MwnHfMRefGzAJpVqunz9QE5St5R9uIPxOrm5r8oIieK
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/api/v3/identitynow-v-3-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 'List of branding items' (get-branding-list)"
|
|
---
|
|
|
|
import ApiTabs from "@theme/ApiTabs";
|
|
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
|
import MimeTabs from "@theme/MimeTabs";
|
|
import ParamsItem from "@theme/ParamsItem";
|
|
import ResponseSamples from "@theme/ResponseSamples";
|
|
import SchemaItem from "@theme/SchemaItem";
|
|
import SchemaTabs from "@theme/SchemaTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>List of branding items</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/brandings"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This API endpoint returns a list of branding items.
|
|
|
|
A token with API, ORG_ADMIN authority is required to call this API.
|
|
|
|
## Request
|
|
|
|
<div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
A list of branding items.
|
|
|
|
</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"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"name of branding item","example":"default"}}></SchemaItem><SchemaItem collapsible={false} name={"productName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"product name","example":"product name","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"actionButtonColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"hex value of color for action button","example":"0074D9","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"activeLinkColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"hex value of color for link","example":"011E69","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"navigationColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"hex value of color for navigation bar","example":"011E69","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"emailFromAddress"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"email from address","example":"no-reply@sailpoint.com","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"standardLogoURL"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"url to standard logo","example":"","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"loginInformationalMessage"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"login information message","example":"","nullable":true}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\n \"name\": \"default\",\n \"productName\": \"product name\",\n \"actionButtonColor\": \"0074D9\",\n \"activeLinkColor\": \"011E69\",\n \"navigationColor\": \"011E69\",\n \"emailFromAddress\": \"no-reply@sailpoint.com\",\n \"standardLogoURL\": \"\",\n \"loginInformationalMessage\": \"\"\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"}><p> An example of a 403 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
|
|
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
|
|
|
Internal Server Error - Returned if there is an unexpected error.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><p> An example of a 500 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div> |