mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
81 lines
29 KiB
Plaintext
81 lines
29 KiB
Plaintext
---
|
|
id: put-mail-from-attributes
|
|
sidebar_label: Change MAIL FROM domain
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW/tv2zgS/lcI3Q+7LSI7SdPmEuBw5+axyKJpc3GCLpAGKC3RtnZlUUtSSb1B7m+/b4aULD/SZrvdV2G0aG2KHM57vqGpu8iqpDKZm0b7V3fRpVXmQBdOfXC9yo0xFtlyv9AuG2aJdJku4onM8nho9CSWzplsUDll929BQUXX99cbkS6V4ZknabQflZU7xYJjzO8106ONyMmRJeqvW6RthOWpsonJSvqO5QdjWYyUcGMlTnsnr8Tx+ZtTkWrwUAg9FLIQvbd90T/qC0V8iSxVhYMweJKK0ugbDPjVP/DQxQ8XwqhEm9QKp8VAiTKXiUoF6NG0ROa5Mt9Ycfi6Dy6N+rlS1r3UKdRzx18zoyCXM5XaiBLSVOHokSzLPIjR/dES73eRTcbgij65aakgjR78qBIHuuAMWnIZVIGnNdOtmRaqKkaYqT7ISZnT0Es96E8yN/6PhaClzgrXSfQkWtTYBaRotKBNrSyZpkZZG91vRJNgj0N+8vFNw6fOp/cs1O1KE7kWPx1xWllHWpfCVoMHJkX394sbzAjPfE4MIZ2sd+o268m5MsfcL3veodOkgkbAtvIf1vCixh5Qy/09cQ41l/Blb9rtzU367yFpZoyJ2rfILW+UyYZT75AcANEf7GsDPejYRzrbfOD9Wgcbav0Y55ITxfFem9uNpaPoX4j6CmoXEn9FAkfTkyWPZPY+nHMG+DhjW5tiqFQ6kMlPsZ24slPZWEnr4q2OnMhf2MIr+UWm8RnGM5m1TAvGPV91iiFjI+PoW7Z1LZsmAiq7UWKgqyJRnLmwFVIVlCTa2dj6TbwaQr4zVliFFVNdkbjug3uMvDf/suVwCywmeZWq/TkZxf/A5LJhmlz6GEkp0A2YI/GIUeUX9XgfzuBYL1FztMl+8WHAUnjRqN6QQKZtxzk36zvpKrtSxqKaUKk5O3p9ePL6O4z0Lw8OjvqU4I/hH0eHVHdmmpjNW3ZElEoDXxOWd6tT18zLOHKDbX7PPBZyzc6q9HKQZ8TikTEgHItz5SpTkE08s6GmwbfSKek8K25knqWdL5djUuXA8IFO1SpzzDN7nBUqHhmIDg4Vs5xgYfBlrBATbRAaTLLWN8/rzLkvNNHZEi9lCnm9fAdBGAoBgygGrZOVMTDP0GWRYb2ol8AcbKAHtlW7Sg5ebO5t7wxf7Ei5/c+drd3ng72hfPZsc+/53h77KequHKm2b0pj5HRp6+9UAfdJRK4BQzgIDDIOooMY4M2xBDhrYj9tA6bxCP2TU/u5jZiBX0EgcAOe+fLgTOzsihyFqOJxOVpQQhFfUjAVVZ7LAQ0RPILknvAbk40eKAMhMg+PjnuXry4wcn7038ujPj4RrSU02CvgrSm5JViFL4xD4gwC3ErKfDnUodKOeBqoPoVAkhNlMzHz3+zUQpnwraGscocVYfcVK9qkfTJqh1LiEbP4NuuozgbwDcYm0iVjMZAWC7QHl097SaJKF78KmnwqxkoiJT7piF6aZiSkzAWiEUSxfspAKU1n6HRYIZTBDAqzrnwhSNS8LWaqnLfGLJm8ahuFggOcf9pPeomrwByL2Y7CxlsCi8E+4Nlrbp67i5bSWKXTwskEUqC+TKFGJNcEmQmyZc6KkI7IXBaJp6jnNRmLUmAtFqe7U88Mozw8S2RlHxF3Z1RXYxateXCjQvDZumBRJyFnZgoZCQ9JbF4cZjXmqgNfDDOVp+vYXcfuOnYfGbuLD89DUxWeMvTZWoY+l0ULQS5BH8PeU+gGZjK8CYbcoGY5QKTv314gsH9SBc1XH0qCtF8QH/lSvsR8r7GHHx8Q/GiMNWcLYpD16CUYIhOpdJ/5nnHMivKqera827E2gwwOWqyAiMiahtC2kFCZqYqCOJF2AyBV2eIbJ8YS+VEiIqz1GZB2LdLYd3FrJLlGkutqtK5GX001WiPJdeyuY/fvGbsfRZINVxwtASfZajKRZuo9LTz3h8+YIOrjfdGEHJtqEa0QMdFgrGgeOUSD7a3B1nA3UTup3ElfPNsbbicvtuXz3a3drcHO9m7UrvVXszhugmw+plr29nZkFQPE3QDHVQUdCTut0/njP6jXqCGfmLsZJIbtAODurxvsuL23jB0vtBanspjWCMnOYchipiPKaZg7obmmnku/RokR8mIhkKoy8EWulE0UqBg4jcizScbBS1KArpnGvaGDKD5Qaidrdgln1pYzQa4JNWs4Vka/NA0J84ECI9gRsvMXRKfBRL8JyYtzkvgVSSyOPiRKUaA3yP35qvPdEzBvKEf0vYEfOOj13Y4s4ABoCHzOanDnGp+v8fm6xq9r/NdR49f4fB2769j9e8bur8DnAQ09jM8x4dH4HHM7m6LBUsfkXH84TOdQCRywewud8BWDdIbBGVfAlcJtOsohkm7mRd1VN/Hw2ON+z1FlcswcO1fa/W73DoaCge47ssw69T2DQt/SHY/uANpZkXjohoAPMpogemcnobHosGpNRt7rUx0T94pmYchP66s9H6VcX+/hCx6ezIaApwdP4mG6/4I24hvLszvsOUvyQa5Lk9//dlk8oQdkWaW+j+6G+QKcLohIIlxvNPcv+4S5/e5LtzBndYT6tO2lzd7QtG3xUknDN2zop4tvv3978USMCGlypFeWQK7KqDVArJzBRTiT9epjfFrExcXoajRmxntzP5RQ5IhhDoHFu6KvlLg6CUp4jRR/jpzMKqVFitMArbr+trZOqm5UTtVv/sJXN0uLLjTUlXPrnnCl45YgK/BxwqOdd0UsDjNKQHz7ieYEEbnDE1dlLZdsyfW5TPyjphZ7ajFTs08WuPCqvUr8xZsE4UskZG5ZW5+9uacXt+hR/4QRorrIA2ki8DH/81ZSW+2z+ZijFxO9eT7eFW/HGcro/DLhs5awqIJ5Kk5EMtbaqn8LQa5DYXA1qhBFn83WLW0ac0TE25stlmK/ZZzFAIXM3ysERuGdSQ6oKDMm0YBr/p6cEe/Zsoj593zb7v2czDx8RTfY+AJaYj+bZ9owpg1jnwNs4N+XJnIsxDbJwHnAO8DBzP6cCQKjrbznaa3M6ky+y2uoNCRglanYct9/2Z8luPBJ8AOa3cyh63/A1M0PfvguAi2qT3PKqk8DFjW4zG+uURYX9Ob5bU6jqFT+1eQliXuzQ5M3RT790ln6gUzy18m7f1LGW2earzHTBJRLh4/nsxcujn6fO/rozeHWLF5oO9rB9DLgwuXDQsvvkeBfPOWcwMAdbRE3eoyW2oTKXDqKHs4eyThTfMxQKukIY26QB4NRivjSaEozaCaZ0MhgDtKDBfaVgyzn1yYuZjtLDkwPYMl/6LutuNehvfz7Ah3xFp1fkcD81PXRVQ48+1GH9q8PlZyRSsRh7VQAd5NJVdAlerBdTYSE637C89LMJpVPkGgCC1XrQjPEbFbV2YJcmkTocP9jJvbNkE6w0Ry3HOwTe8G/bDi+hurJitQNUGvVCHKu8vA20cZCe/Ap2vDqeKzykpwE2R1AT7V2OD25WKIIYoWFXOjvtRl1wyLbpbkgQm2Yd59nna3OZsxtCcZLbR065Rbx8J7T0usKC254Nzu4/7NfjQqljnqULr+YQIJVvmfyDepVtLJBRcszhvz0/O6OTl6oY7unYYQ+tfVX17NmjL6Brj+B4Y72J0VpIBz5xxdTrtyhxV/+LYN6RL/Cn+p8dO51q9M+uyRrD8KLXxN/ZmDkLQbp3/3oHf5E9Lab9zV6O4zG76L6BA5zPNkaIa0CCOEDSXl//38Yv3or
|
|
sidebar_class_name: "put 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 'Change MAIL FROM domain' (put-mail-from-attributes)"
|
|
---
|
|
|
|
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"}>Change MAIL FROM domain</h1>
|
|
|
|
<MethodEndpoint method={"put"} path={"/mail-from-attributes"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS
|
|
|
|
## Request
|
|
|
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"identity"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"BobSmith@sailpoint.com","description":"The identity or domain address"}}></SchemaItem><SchemaItem collapsible={false} name={"mailFromDomain"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"example.sailpoint.com","description":"The new MAIL FROM domain of the identity. Must be a subdomain of the identity."}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
MAIL FROM Attributes required to verify the change
|
|
|
|
</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={"identity"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"bob.smith@sailpoint.com","description":"The email identity"}}></SchemaItem><SchemaItem collapsible={false} name={"mailFromDomain"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"foo.sailpoint.com","description":"The name of a domain that an email identity uses as a custom MAIL FROM domain"}}></SchemaItem><SchemaItem collapsible={false} name={"mxRecord"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"10 feedback-smtp.us-east-1.amazonses.com","description":"MX record that is required in customer's DNS to allow the domain to receive bounce and complaint notifications that email providers send you"}}></SchemaItem><SchemaItem collapsible={false} name={"txtRecord"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"v=spf1 include:amazonses.com ~all","description":"TXT record that is required in customer's DNS in order to prove that Amazon SES is authorized to send email from your domain"}}></SchemaItem><SchemaItem collapsible={false} name={"mailFromDomainStatus"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`PENDING`, `SUCCESS`, `FAILED`]"} schema={{"type":"string","enum":["PENDING","SUCCESS","FAILED"],"example":"PENDING","description":"The current status of the MAIL FROM verification"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"identity\": \"bob.smith@sailpoint.com\",\n \"mailFromDomain\": \"foo.sailpoint.com\",\n \"mxRecord\": \"10 feedback-smtp.us-east-1.amazonses.com\",\n \"txtRecord\": \"v=spf1 include:amazonses.com ~all\",\n \"mailFromDomainStatus\": \"PENDING\"\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> |