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-templates.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

83 lines
33 KiB
Plaintext
Raw Blame History

---
id: list-notification-templates
sidebar_label: List Notification Templates
hide_title: true
hide_table_of_contents: true
api: eJztW31T2zga/yoab2e2ZXAIAcqRP+4mpbDLHhSOl+vcAdMqtpxoa0uuZJfmGL77Pc8j2XGIQ9m229vupcM0iS097y8/yfJtoHNheCG1OoiDfpBKW7zShUxkRBfPRZanvBA2WA0KPrJB/zJo3rfB9WoQCxsZmeNvIHE+lpYhHcuKsWBFRQF+8YJNdMnG/INgmY6BiohZog1eNczKQnSAjxVRaWQxAV63wYUVZlerQnwsBmUxRv4yVn3VkCGsWfSN4HFwfQcy5dzwTBTCWCIjUbL3pTATYKDgDumaySK4L/4R/8hUmQ2FYTphRtgyRU00fC1KozpX6kwIdvnPDTY4OWBnBVcxNzHb1WkqIqTBTmrW10/HRZHb/tpaLD6IFE3dsVymuZaq6EQ6WwNd1ngu16ynE0Y1nXCqwjMyUqaNYFLB14z0RlsZ8b6URoDrEp5asRqIjxyMAer1trpgymgsMh70b4NikqPOwFeMhIGZjoy7tNGDC5lUMiuzoA/zMv7RfScqsUg4WIF+3d2ttltTJ4kV8+Y8pssgNlgQwyEp09RblcGNDruwJU/TCbO5iFxA3MhizFbIOyto+JyPpAL3wnyjy9GY6HjHfDfu+AJn1OZfbPxEphTqLUxsYaQaBXf3HbNPU+oALy2MIstWujM7UQUkg5s2BMdI9Y0N/YPTCyQLvZzPrtSV2q+uMqg0tsxzbQpfSCjEgJS+wdsQTmlsGbBgrsxpY/tIYWXlnZisrPTZini/CnqtMnuz4m5kIpZlVt+rr6c64qloXg8a7g3cNCbes6tg72hwcHgVBFiHQO4cyiQUUHBJr9vFj1lHDKhYYrGp6hjTw1/BFna2NAK7CAuhKpAGz/PU17+1Xy0Sup33PTeGY5TA7Mw2rjv6cCM3aJdCOvHAJvOB01QySnUZv8m4gpR9c6PNuzdI+Y0ts4xTON7vBIIBTVKt0QkwFl3cPsTrnNt37IgrDhnCzsrhlHAbG6RX8Vk8Exg7P7WxnieaCWuBCHNzOuwIM979sCzjEzYUjMexywxX3KBFUA8TCplculCA3yc/H7/ag8+zozP8/3Cw+3f4PN8bwO/rptpuAgjq4u1xgrqxdQJUcmPTXGWcvdg9YZvbLOVqVNJ1PurM2FqQaWzpwuJBt/yr6t9PXJM8Tk6EimEUWt2yJwV8uK9QuSHTYVaBZZI9uX3zZpTqIU87EHVxGRWvwGd3nVaFvCiQGUpUxm2Gzxj6PBTOFkkV9Bc+RFELUzYLMN5AVrkRkDZYot2AeeaOOPvA01JghVH6hixc+N7k5RnqeOIqTIcdJCBllJZx1b4U1DHk6KjYVbg67XtAgLPNbreDqiCZh01+kgpuBRtp5nso2hjijwK81XwkWovZEq2L381sjvi3MltidGsWT832pI43KIoy3YcJgzgGWrbVZlcBjuhfBZjSOKrNgEbk6eRcf2XGp0iVnWvgvSjgZ6Y9xPwlcJywWI4E9JQQIJYCwyUNRKvLgpoutXtKVCobGFL6RsGYv7Juq5yNK20SyvgTvWN9eyj4Bg+3tjfjcHNrIwp3RHcz3Nx4vpUMky2edIctfCGQ4I+XhQ5HQmEPFzEFQARYn+JxnmmNpmIYERYyE60K4Q12MxaoC/Couy9898Q7bJEATc163V437K7D33m326e/Tpf+/Zs6jl/o/A6S3nBYaXFwdMXjKwh810Sxl4QJ6q5ZdyVoWYUsXJ/2wrwsNEy+w/mbbTBnN5UYi3vGQLiF7JRWU9g6E4/nAdKCJq50YfJBCZAk+G9FPQvQTSwKyI1dHT+iqe5DGoYjwyVKKEjkCCYyoPhBUuoQ+nckK9xB42YtjdVqnb3gMejr9Nv1yoCZCsOjd0DroDU0ZgW6UBLms2oKk1O428JWbAs+fN7d6W0mzzc57/1lc317a7iT8I2N7s7Wzo4DQgQSbAtcnGX9EwaRjBzIkP8Bg0BygO1JAGL+eIT5bUFNeHE219pqZHVs5Ei2F1OP3V7u7Q8uDs/hyunePy72zuAb0prb8BhgPYwxLDVV2DE0vmKqACapFbi4wfxc8VRXQCGubHOgdL/sxIIxmV/1wQzPvWVGkzTDjjiTSpHbNmFPZUd0VgGsYqHgRTRmQ8ATsCRyRXxlEEUiL8JDb8kVD4CedRi0LYlK8qohP4B6qYFDc2G4NROJWV9MTXkfaFRl5LDpFEwOkPzTcTKICliKUEzMZGEdLV5E7x+Q2VluVrrzhtHIpLjwhbVoRBsTkTYGsegQdJOwKPPliNaeUHhUNa6uWFgCK7Wo3B05YVyFhHrGS/uIvDtJofyEpFp944PwyUfw2lUj8kblJl+RKqCIk/2o2l1V4jsQtszdZe4uc/eRuXv/5qnf3KmwD0Kf9Xnoc6EAjY21oeY5B32MXy2xahDBG+/IVQYG8RDpl9fnkNjvAAXCePExR4j2FfGRa+Ut21OVP/xGYLVPWLX+qS9QQLKj0yCBSiTiPsk9ldiBRDLVxjy3fW2GEgJUtUBEqJq0HcY4mMyUSqEkHBaJsRZW/Vi4fQkOGWGtq4DIVcWh23ZcIsklklx2o2U3+tN0oyWSXObuMne/z9x9EEnWUlG2eJxUPWSjSPP3UVvcEt9g1WNGVqccueo+WkFirMZYwSxyCIa99eF6sh2JzZhvxs83dpJe9LzHt7bXt9eHm73toNnrL6d5XCfZbE41/O386B7tCPMBcFypILhsoXU8u/0H5jUiwbKGpafGzWBzMOl1jR17O/PY8VxrfOw3qRCSncGQamojrGkwNsOxphpLTxdGUBcVg1IlQS4MJdx4DRnuoTI6kOC2WAXSNZNwkOATD/+8yAdZzcU/2bBUCVKNqFlDYElQUiSI+YACIdgRVOeviE69i74IybNT1PgQNWZ7HyMhMNFr5L7Vtr97AMIbrBFnzsELNnrdaocrCABYELiaVePOJT5f4vNlj1/2+D9Hj1/i82XuLnP3+8zd34DPPRpajM9hwKPx+RY+imc1ltqng5/fGqZTqngJKLyZjqLS0HZzhcEJV0AooUAjOvebczyeHay1H80O8Fw3AkMnU2lSGFudEr0FV4GL7jo8lx2oYOCtYqL0DR0VHYJ9Fh4MoRNFMIAOpToGHTKukRi/rtgRcWdqf5I2qE+jPki5OlVIZzAdmVUGse5jiS7jGTdYSPxoaXSHYmdOP9DrwqR3X66LI7RAlzbzPcgNxjOQ9J6KqML19Bj+GaJux33uMP60k+BKrTfH7BiH9dgLwQ0sCdzDi6e/vD5/xuqjKf7ksZC4OIBsOYEQoVo2qDbycRK1l+np78HMoxLMHZakoDDzx8EPvBFeQZE/hapMJsVJggoBznr8GWU+M2/B4e8rFbKX0rgjzO5MlVeR1njsMq/04g29PleIHypqoaMWEjU8HT0jhTPtZeSO3kSQwEiCp5as9dnMHb2wQQ9XUHAFqd6XAS3h5Zh9wBVVXvtsOWbohUhvVo4r9XosoZHOTmOubjELfTCN2QGLxlpb8TfGMHQwDS5HJWTRZ4t1g0xDyoiw122IFDqWoQwBFpJ8h5AYygUTH2JbJlSiAbCp2KXkW/Is5PxbOsb+dkZnunwJ3RNHxjr6DQfv78mMDENkGLoaYL38rjlhYOFpNdCB6oALgN2p/6kSeEEbdc/Raq3qRH6N5mBriEBUomLzvvvRnxY4/43RDRxdj4EyjKi6fuQHv5mnhR1qxljVfsB9C87Lm2pojPfs5uSt96OwWf7R9EWNB9Ntk2OVTr52lV5QSf44dfd/VPGWlebPWGk8zsVwI7Z+QdAM8hcer81v4+E+81jA/3CXcpUgNSxY3El3RDFNQoiSMaopq6OxFLQBkAteIPZbpfO8GWUirNUx/WGZR4RGdFTZgMgclmwyBXq0RV1x5pQwDliiX/F39XoFvqIxhgWl6LDXsCZTEbgF12N4yALu/ar9wuwMPHOCjmUvK2cD6MqyUgE3zMsyYxxC6hMREUsblda/GaKUqGyhCfrVs6osxlBDFTq0MjGZPU5wbxmWrQ3Hf4IX+N36jWXuXm3xb8xNFTkVqX+VdfUebP8UbYi2cCzSnF7XAbFgfdfgcHRwPkcRiCkLesHKW5vRmp9k13AsEMHlkQufjc56pxvScgGu59oWsIZtED/EV8aaL+Ky5pu6994WqLfVv/zdXN9IcAWwluO2FYpXuhWJWwBeBgsWgLCkGIMeOOL2Fvc2cEV0h5fdy4y4LATLYrhP359cqMn39Zpuq9nodbv6LWS/HxAEuHx8vB3+v96vfcCO9fvHn2nI5fuwX+F92Af8M31Feeqg6+nuBqT/dePFvkv/Nmrgtj0bs+YeDCKVeivqpz0sunwB7PVfkNXd3X8Bk+rBxw==
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 Templates' (list-notification-templates)"
---
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 Templates</h1>
<MethodEndpoint method={"get"} path={"/notification-templates"}></MethodEndpoint>
This lists the templates that you have modified for your site.
## 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"},"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*","example":"medium eq \"EMAIL\""}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
A list of template objects for your site
</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={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"cloud_manual_work_item_summary","description":"The key of the 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 Task Manager Subscription"}}></SchemaItem><SchemaItem collapsible={false} name={"medium"} required={true} 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={true} 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 line in the template"}}></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 in the 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 in the template"}}></SchemaItem><SchemaItem collapsible={false} name={"replyTo"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"$__global.emailFromAddress","description":"The \"Reply To\" line in the template"}}></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 in the template"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b","description":"This is auto-generated."}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The time when this template is created. This is auto-generated.","example":"2020-01-01T00:00:00.000000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The time when this template was last modified. This is auto-generated.","example":"2020-01-01T00:00:00.000000Z"}}></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 \"id\": \"c17bea3a-574d-453c-9e04-4365fbf5af0b\",\n \"created\": \"2020-01-01T00:00:00.000000Z\",\n \"modified\": \"2020-01-01T00:00:00.000000Z\"\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