Files
developer.sailpoint.com/docs/api/beta/list-from-addresses.api.mdx
2024-03-06 16:17:34 -05:00

69 lines
24 KiB
Plaintext

---
id: list-from-addresses
sidebar_label: List From Addresses
hide_title: true
hide_table_of_contents: true
api: eJztW21v3DYS/iuE+qHNYrW21058NnC4bhw7cOEkPr9cDnAMlCtxd5lqSUWUYruG//s9M6S0r3ZcN+g17RZIs5LI4cwz7yRzG9lcFbLU1hym0W6UaVceFHbcS9NCOadc1I5KOXTR7kX01pZ6oBMe7KLLdpQqlxQ6p2dMPVFlodVnJaQgKsIOhFMmVYVQY6kzIWuSQppUlCOlC/FZFQ1J4UpZVn7JXBZyrEpV0MK3kSb6nypV3OCbwRfmdKzLaJ6JN/JamGrcx6pYH+tVWelEafGzrArT+WBOlRIX/9kUveNDcVqCFVmkYs9mmUqYi+Nm6csfRmWZu921tRRiZQRUx0GS3GpTdhI7XtOpWZO5XnOBTpw0dOKJCM/EwBZibAsltMHPMYvbAe+F+lTpQgH4gcycakfqWo7zDOJ1n6+3I5eMAF20exuVNznJjHXVUBWY6cn4V5tdvBhro8fVONrFvLG89r+ZSqoGEijw091dezmadjBwahHOd/wabANBaEwMqiwLqEK5ZUecu0pm2Y1wuUqgSZWKK12ORIu10yLgcznURpYK8wtbDUdMJyjmm1HH71BGA//94Ce2MovYHw5Eqywq1RK6BKoAPrd5lXkolWj9Nz6zpcziPZrdIkhz+KUSIyXJ6VgPNHCJO4wkKNoqS0VfBc+A5vSg0Rt5aMvbREtcKYJqaIBYCo1BZ9okNA9iuFKbITy+JFYECyISacRIciCAjhgcGq/HuUzKNkmjHWZDY2OKD6kwtiRLoWghWi0m8k+WvEU8MbefZVYpjwKNBtuIFIGbb8KCSJ4lRtS3NlPSRFN2wjPvtZWBzjgsLqHlEH/NMLqbN6QDntJov3KkMrKMWkrhbkyJwOmn9ckUzB8M6XdeLnAWBz6fkW4P6rdkMq7Kc1uUYI/g53AEUvaKPiP0ZKnPLD6h2cLtEoVWi7NPq7UrWupTWwxVW2T4465a0ZR6Ip+j1CfxIfpoR6aTWvUj2M+luSExPkTRfRpxxNODGpmKEGT0MnaKJIcki8o6BbU/uapI4HlFnfp3j1MTVFFrZVEH0d0l+ZEPZo7A7K6v01+zOB2FEmOf9XbKpQOIJRZRGcEU42WeZ6G0WPvoaNLtooZkUUjSpS7V2E29t/2PEJwqkYKAKrVnRadL/c0zvkTvE9l8KfRjeEFw08Tp+ifIsIyKoVxyER3vv311+PY13pye7+3tn57i10Hv8Gj/VXSJgBGVuuS1GBNP7lVpozv6rx1trW8swnhuZFWObKF/hb5icTKVC6A5CnAOAVfUg3yh5jNMW0C9fpz46f0ZIvgvytB4dZ1TDOw8QR33wK6KwhaLzPfEGAWlHKraHWpv8eOn4ScGkUN06iUYACCV7jLfE449UgzV5uJqB7bo6zSFjAs4UTIqxI2thARkRWUMZ0XXFggjznxfhnyYJOBXcC1Fq5o09s739ZBKVQnR9myqlhnSfF4wKh4WUpMgDBkSeKoEKH7WKUnAKc6TJF9roO3MYLu1vt7ZEC9lCli4JED88cKQTRYy+QW0Dpd4zjxD50ZjvqinCD0JIUuWVdtK9l+s73S3Bi+2pOz+Y2tj+3l/ZyA3N9d3nu/s0OrBPtwSj59d+rUycMVEZDaBlZAzFEo6shQwUJvTI4ME03gE/meQy49txKztuVTXqJSkeLl3LLa2RSbNsOL3cjgHgonPKQwYFOayXxcakNwTflfooTYPxZRX+we986MzvDnZ//f5/il+Ea2F7q4H1zYpmaXlWnJkr5jjIMCVROBXlCzg+KIVqLYgkDRueqD2T+7GAUwRih7MCKsvmTFNWgzQm4YOwpsa+811KX7QHdVpozDEO6TaZCT6EhWigAq5Wu7B9/IyPgpItkIQe9YRaHU1CYn6latMh/k3VGGiYfX51Xc+8HjFVbWtSipCdaJmdTGBclYbk8B8NK0Ucg5w/mU76SUlmiy2iRkvbKwlsBj0A549crPcnU2BxpBSIYHcnnD/ltgCFTkKa8imUXmEcMT5HIHH1OO04SjaiWbyDXHzxjPjEw7imazcI/zuOEP4iVm05sNnFZyPQ6WPRqyNWk0hIoWelCeHUY26asf3FcfKd1e+u/LdR/ru/MeTUIvz14Yr9pZQJ7kKTQ1aIra08J2klQIDJhsTjcuxquarFSImmhormq0con53o78x2E7UViq30hebO4Nu8qIrn29vbG/0t7rb0XSuv5j4ceNksz41pW+vR4YYRRwKclFRpe5Ka9MZayV4CzWgsEahp6mbgTkgvWxqx+7OYu14Zq14g1ayrpDcTA1pJhhRTMPYMY0t6rEYIMUQcdHQhooGX2RKeqxAhdpIwbs25LwkBe3D3sS9AfX8YS8oGFmzijZJVoFDjgSZparZwrA0bawMqOYDBa5gh4jOX7E6DSr6XZW8OCGJj0hisX+dKEWO3lTuz5f1iodgvqAYceoVzGZ9X7cjDQwADYGPWU3duarPV/X5KsevcvxfI8ev6vOV765899v03d9Qn4dq6P76HAMeXZ9jbGddNLXUAZ9W/dFlOrtK4IDNW9gkqQrebq5rcK4rYErE0JAPtXNZjvCw5rfbVRqTqcdy6o6DL/09U1WRYXB9WHILXUFHdx2Z6w5CGNRV3hh7xScmfQC0JPZAs8EXaQCfzfgFOoxuocmAfbRj4h7rcP4XNYcyD1Km0ydS4o2tEN+YTFvA2IMx8etwgPW949EdNp4F+SDXeZHd/X5ZPKF7ZFkG34OrYbwAp3MikgiXpC4oHYRYX+fgZ8+Hql5Fir64nB5zSqW553Bh5CTdUDvXXbz/QMO64qWSBfoGf8Lxw0/vz56JIRWkHBD8IZ3S1EHApY5hRhzwevVuP03iHDS5/9CbOU8hBxODDKCIcJx9GIB6i0xwgtDNsNMkxdGCZj3+OE/OzLvn8PqDicUrXfjTPsdjgoj+gP8ir+WSU3I9lYnvamqxpxYzNTpKnOHCQ3uRZJriZQIvJxIyc4zWkxf39OIpetRm4Q1RneeBkAh8zJ6CJbXWnszHDL2Y6M3y8cG8H2lk29lpwgc34UZ8g+NQJCNrnfqXEGQ65CoXwwqe9mS2rmjRmD0i7q5PsRT7JWMdo3Zk/o7gGMYbk+xT7ubSxaKqM6l3259Zs4gLP/Ph/M8zMvPrC6RYGpna5DecUc/xTAvGtGDs44QL/PsMRoZFp/CQgeOAN4C9if45EgRGp2Kjp7U08jP5NZ7DJ/9glam4fNc/7E6CYPgl+AONbsYgVFPp3ZwL4lkEWpTGZsCqNw3mEVzkN7PInnO4eX6bTSvKqH82eUni3mRv5Z3Jbr52lL4nkvx54u7/KeKtIs1fMdKEYpjMjZcNXcO0kb8MNd3iXp/ja4b4P76yr3Ldja5mcrNwmlCeyZKsmr06GfFF4ELlSpZUH7bJsuyYPRENfeLvATOhYYExcFuHulX2dQZ6vI9dryzZYXzxSXqlZ1dxq0JrJSN0naoj3qNxMwnUQk0b3cTAt482dG+n0MwxKVa8qpWNoms8rgxWI7+sxkLCpL5gEal2SeUDF3o4o2osLJd+zazai8nUSIQOty/F2L0b0AY0etspxX9hLei9vtYE6EmL4dbZRJATlYUr2e250v5LtGFt8UhlObWNiLoowNTUCm8OzxYogphxkAvtuS2Ga2GSW6Ox/jqT8+az2dnorMfcUuB9bl2JRneKOF/foovmYvqm+YwJ3k723L/q3fKQS6gJWMtpe4s4rHzj4hvFi+i+RhFtxQiy0JDbW9oEoc7pjl77S4HUjgBdMvnJHdB7pfq2Lqsvxe0XRdsK9V38sHHg70o+Hoe/1y3zB3BsbuE/EcjVlfFv78r4A+ZQ/7uAJ1rD6t73vfe+HwB9csH+ibD//W5wP4Dm5HL8BM3Lyb4h79Uhp3L84ezpp/kThalZC2fuRKXZ5X29j/Lj7n8Kol91
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 From Addresses' (list-from-addresses)"
---
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 From Addresses</h1>
<MethodEndpoint method={"get"} path={"/verified-from-addresses"}></MethodEndpoint>
Retrieve a list of sender email addresses and their verification statuses
## 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":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></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**email**: *eq, ge, le, sw*","example":"email eq \"john.doe@company.com\""}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **email**","example":"email"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
List of Email Status
</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={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"sender@example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationStatus"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`PENDING`, `SUCCESS`, `FAILED`]"} schema={{"type":"string","enum":["PENDING","SUCCESS","FAILED"]}}></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 \"id\": \"string\",\n \"email\": \"sender@example.com\",\n \"verificationStatus\": \"PENDING\"\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>