LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/list-notification-template-defaults.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

83 lines
32 KiB
Plaintext
Raw Blame History

---
id: list-notification-template-defaults
sidebar_label: List Notification Template Defaults
hide_title: true
hide_table_of_contents: true
api: eJztW2tz27gV/SsYbmZ24zHlZ+LaH9pRHHvrrR27fjTTsT1ZiIQkbEiAAcg4qsf/vecCIEVZsuI8Nt1slQ+xRAIX933PhYDbSBfC8FJqdZBGO1EmbflKl7IvE/fwXORFxkvxUvR5lZU2Wo5KPrDRzmXUHmaj6+UoFTYxsqDvoHQ+lJYROcvKoWCpJ8DKQNCyyoqU9bVhqk1omdkqGTJumci5zCzrG52zg1SoUpajV/qmAxasSCqDr2DjNrqwwuxqVYoPZbcqh8SaTNVOm2pcrxoHNuyOETyNru/AdsENz0UpjHXkJDH/rhJmhIUU3jit5LKM7kt4xD8wVeU9YZjuMyMsEWalxseyMqpzpc6EYJf/2mDdkwN2VnKVcpOyXZ1lIiEa7KRZ+vqnYVkWdmdlJRXvRUZG6VjIX2ipyk6i8xXItMILuWIDnThp6MRjEZ46jebaCCYVPuZOftKZEe8qaQSM3OeZFcuR+MChFIi3/mwVKk2GUHi0cxuVo4JkxrpiIAxmejL+0cY6HuRSybzKox3My/kH/9lRCep13+7ulmdrU/f7Vkyr89g9BtvQIHlMv8qyoFWGFx12YSueZSNmC5HAtPCeG1kO2ZKzzhIpvuADqWBmzDe6GgwdnWCY78YcX2CMRv0PK78vM+fqMxaxpZFqELVYid6KERPv2FWUZLpK3+RcwQRvbrR5+0Yipt7YKs+5GV1F0d19c+67hZqwqCxoO3vUGmN2pEqEkJ/Wgzml+sbm+cFrA5zFgc+nV+pK7ddPGVKYrYpCmzLkKueYIKVv6DWcMEstwxLMp1Ft7A5RWFqC5paWdtiSeLcMuZDVbpb8i1ykssqbd83zTCc8E+3nEWUn8FUgLQpLhlpfXaU/k4ruuixLKWhWnmW69xvkJoMnlCRVSRR4UWQhN678ZonM7bQ/cGM4eQ5Z2raee4p4URiSupSeOUg835nm+9BUPjiHNOR/DwhGHud9et6a59y+ZUdccUQPO6t64wVmLUf05q3nbTdrxWlaubAWqzI/p8OOKAn4L5blfMR6gvE09W7v8x2qhqDcIBQtchntHXUPDvH95O/Hr/bw9+zojP4/7O7+A3/P97r4ft2W1k8Ao96ZHseoH9t4d8031dNlxtmL3RO2ucUyrgaVe84HnQkVC0Ur2sp7xVxr/FtXbMjfC/bE183j/olQKUaRmSx7UuKP/4hkjjDGrJIyJ3ty++bNINM9nnXgdGmVlK9gqrvOTIECKw8aEn6D0sJ7xFJpKgHuh0ADSK8zmJ8c2hKGXtDqhREIJErkfsA0P544e8+zSlBGUfrGKb0MFSzYv6fTkc8oHXbQh9RJVqV1kVPIW7SipwKUdCPH1REEONtcXe2QIYjMfCucZIJbwQaahUpLaodLuiCZqVHH2py46Gtd/m7q88S/lfoIbs5X35PGFR1C3ceEbpqClp2pu6uIRuxcRRTtNOpT/NKIIhud66/M0ClRZecaPDmFfQpHE/TmcfUSrIxYKgcCxSkGglPQdL8FmHVVuurscIELepeCyBf1jcKYv7LVmQK0njyec7COBsLXhLqnKXVoa6I7+rccbc6qr7uZJN73jAF7MTt14J7Sdj/ASyAsiOj8D+4pFXxMpp3PKLgPFNZUlNDlrk4fkdD3pRLxwHBJHArHcoKJDBTfS6dqB0Y9yVp7btxkUqdwWGMveAp5vXy7QRhSpOHJW9CijvFjDF0oifmsnsLkGEfNWFZsCd57vrq9vtl/vsn5+l8217ae9bb7fGNjdfvZ9rYvwq5A2RlIZXLpnwW8SCa+wMn/QCFo+qB7x4Bb/PHg5tsW1PjibFbsecLHRg7k7OALuOHl3n734vAcT073/nmxd4ZPRGuqRe8qeGtKbqldRA6RWcuxADdowq0g1CyQU5cC1SUIxJVtD5T+mx1ZKLOORcwIq8+Y0SbtO/x2KCW+m2c/yY7oLAMo4RmanmTIepw2DbTP+EvdJBFFGR8GTS6FSvu0w5D/JAnJ64w/B3G5CoFk5PYhEjFpi7Eq71eyOpscto1CwQHOP+4n3aQECnY+MRGFjbcEFoN9wLPX3CR35y2lOZVSR4UmJ3F9cqKNIRzUg2wSLVhIR66pQeJR9bgmY7WTpEt3R54ZJEr3LuGVfUTcnWRIP7ETrXnxXoTgc9DOZyNnjdpMISPViIQmh1GNuerA90VrEbuL2F3E7iNj9/7L07CrEN466LM2DX0uFK+gX+OK5xT0MQGOs3qQgzfBkMsMCgkQ6ZfX5wjst0LRePGhoH2vr4iPfCmfsS9S2yPsMNUbUHXpH9uCGHR69BL0kYlEuuP4HnPsQaJT1cb0avva9CQcVM2AiMiaho3Q+3KozFRKESccXUiqhVU/lr4n5ogIa30GpFVVGvv9rAWSXCDJRTVaVKM/TTVaIMlF7C5i9/uM3blIsuHKRUvASfXvO87TwnuSlvZcN1j9+xZrQs6Z6j5aIWKswVjRJHKIeutrvbX+ViI2U76ZPt/Y7q8nz9f5s621rbXe5vpW1K71l+M4boJsMqZa9vZ29D8rCPMeOK5ScC5bap1Obv9BvUb0Ka1R6mlwM3QOlV432HF9exo7nmtNv1GNaoRkJzCkGuuIchrG5jTW1GPd9vUAeVExpCqp/XauzAWoGPoF0P0+TsFLUoCuGcXdPm2phx8mgpM1q4Stc+syQaYJNWs4loSQok+YDxQcgh0gO39FdBpM9EVInp2SxIckMdv7kAhBgd4g92ez9ncPwLyhHHHmDfzARq/vdriCA6Ah8DmrwZ0LfL7A54sav6jxf44av8Dni9hdxO73GbufgM8DGnoYn2PAo/E5xnZWWYOl9t3P6t8aprtQCRz4AwE6SSrjtptrDO5wBVyJGBq4Y6gFp1PD0cr8E8MRHTsmgOh5q0yGOfUxxFuYDKa66/BCdmQ4rKz0jTuL2IOeZqQgOivgw40GuFOPfoGOU7KR5Mc+6TniXuXhgGfUHHecS7k+0DbSFdKcI7PM4PPBp9xjOmeFhuJH60Z3nA9NyQe5Lkx29+WyeEIPyDJLfXNXw3gGTu+JSCJcj0+JnxH69qtPnRUfVxTq2NanFjumYevsheAGrYH/EeOnX16fP2UDwpwu5v3RViGpSUDUnMBFXE7r1hv6NMmVmfGh5O7ETyYUQ6yfQWAWTim3DryzU2Rnp1KaJFxCoFmPPwTLJ+Y9cCb5SsXspTT+jKw/ixNEdL0euyxquXhLrs9l4oeaWuypxY4aHb+d4MKr9jLxR3ASBDKR4HQtANr67MU9vbhFjzopPCGq93kgTQQ+Jn/oSmqrfTYfE/RiojfJx5V6PZR0G2JiGvP5i1nUwyxlBywZam3F3xgj16EwuBxUiKLPZuuGFo1dRMTrqy2WYr9kLGPAQ8ffIQJDeWfiPSrPDp1oADeV+pD81VkWMf+rOyf964TM7vElqiiNTHXyCSe77/FMC8a0YOxzgA38+yJFjoXYJhlcHvAOsDu2v8sEgdFW3vO0ZmZ1R37FzaHSkIBVR8UWO/7LzjjB1cfT3Asa3YxBGiZ03fz0h+8s0KJKNaGsel/gvgan+c00CuQ9vXl+m30pKpp/NHlJ4u54++RYZaOvnaUfyCR/nLz7P8p4i0zzZ8w0Ae+Su7llQ2PQdvIXAa9Nb+fRfvNQ4H+8dbHqoDUaF3+kmlBMmxChZfJqF9XJUAq3EVAIXhL2WybP0rmLRPTsFP5o9xyhgcEYhK0FJuU9mYGe26quV+YuYDywJLvS9/qIP10TGKKxFB32Gr2ZSmAW6svosAXe/aZDg3YGy5yQYdnL2tgAXXleKaxGcVnljMOlPuIRqbRJZcPtBKVErQvtoF8zq45icjUSoeM6FJPb4z7tMaN9bRn+I2vB7vXdHe6vV4SLXGNBTkUWLmEu34PtH6MNb4uHIivclRGwhT6vtcLRwfkURRBTFnKhA9dmsBIm2RUaCyLUHnn32eisdVZj1y7geaFtiV62RfyQ7iy1r5Cy+lg2a901vXfavNlm/11vl4ZaQ03CSkE7XCRB5ZsW3yteRh/pFdF9DCEyjby9pe0Qap7u6LG/jkcdJIxAkTG+AfigsN/XRdOZ6nOXw5p7tGELgW4Nfooe/r9uiM7RY3OD9jMVubib+cV3M+faZ3zJdmyg6/FGCML/unXp7DLcnYz8Tmlr1tRviUSl2b36eY/yM38AIYcPtNTd3X8Bbx12kQ==
sidebar_class_name: "get api-method"
info_path: docs/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Notification Template Defaults' (list-notification-template-defaults)"
---
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"}>List Notification Template Defaults</h1>
<MethodEndpoint method={"get"} path={"/notification-template-defaults"}></MethodEndpoint>
This lists the default templates used for notifications, such as emails from IdentityNow.
## Request
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","schema":{"type":"string","example":"key eq \"cloud_manual_work_item_summary\""},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**key**: *eq, in, sw*\n\n**medium**: *eq, sw*\n\n**locale**: *eq, sw*"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
A list of the default template objects
</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={"key"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"cloud_manual_work_item_summary","description":"The key of the default template"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Task Manager Subscription","description":"The name of the default template"}}></SchemaItem><SchemaItem collapsible={false} name={"medium"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`EMAIL`, `PHONE`, `SMS`, `SLACK`, `TEAMS`]"} schema={{"type":"string","description":"The message medium. More mediums may be added in the future.","enum":["EMAIL","PHONE","SMS","SLACK","TEAMS"],"example":"EMAIL"}}></SchemaItem><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"}}></SchemaItem><SchemaItem collapsible={false} name={"subject"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.","description":"The subject of the default template","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"header"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":null,"deprecated":true,"description":"The header value is now located within the body field. If included with non-null values, will result in a 400."}}></SchemaItem><SchemaItem collapsible={false} name={"body"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Please go to the task manager","description":"The body of the default template"}}></SchemaItem><SchemaItem collapsible={false} name={"footer"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":null,"deprecated":true,"description":"The footer value is now located within the body field. If included with non-null values, will result in a 400."}}></SchemaItem><SchemaItem collapsible={false} name={"from"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"$__global.emailFromAddress","description":"The \"From:\" address of the default template","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"replyTo"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"$__global.emailFromAddress","description":"The \"Reply To\" field of the default template","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Daily digest - sent if number of outstanding tasks for task owner > 0","description":"The description of the default template","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 \"key\": \"cloud_manual_work_item_summary\",\n \"name\": \"Task Manager Subscription\",\n \"medium\": \"EMAIL\",\n \"locale\": \"en\",\n \"subject\": \"You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.\",\n \"body\": \"Please go to the task manager\",\n \"from\": \"$__global.emailFromAddress\",\n \"replyTo\": \"$__global.emailFromAddress\",\n \"description\": \"Daily digest - sent if number of outstanding tasks for task owner > 0\"\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={"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 View Git Blame Copy Permalink