mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
83 lines
28 KiB
Plaintext
83 lines
28 KiB
Plaintext
---
|
|
id: get-mail-from-attributes
|
|
sidebar_label: Get MAIL FROM Attributes
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW21PGzsW/itW9kNfxCRAaVmQVrspLxVX0LIE1CtRpDozTjLtjGeu7aHkIva373OOPZNXoNt2d++t8gUSj33ez/FzHM9ty6q4Mqkbt3Yvb1sXVpm9Qjt147qVG2GsZctdXbh0kMbSpYWOcplm0cAUeSSdM2m/csruGiWT1tXd1VqrKJXhiUdJa7c1VO4E8w8xvdvMbq21nBxaIv52irJtYXmibGzSkr5j+ZnCGnWtxEn36Fgcnr07EROmYlAYIcUwvVZadN/3RO+gJ9JEaQdt2mBSSiNz5ZSxrFtKFH+rlBnjmcYTfE0TfDbqtyo1CvI6U6m1lo1HKpet3duWG5c0y4KlHrbulohXGW2FG0HCX4XUiTj/9VwYFRcmEa4QfSXKyolUi3FRGbH/trcmpBVfVJbRf17XaJYUMK0W1klXkY3UjczLjPj3i77NUzf6h4UtyyLVrh0XeYvMbZQtYToYFeJurq/Tv1khJwwmHhBF/5OKHZjE5GztaJksyyy4ovPJ0trbRVM0C0tDnnap51ybfdFoc3q0lykyb9dz2EVRnDXuJNvnIZD22U4PcxoURftxHhQEohggiILt3Ug6uHGOuahgX/KXFHFlXZEvOI3Fuzljvz8s2Ma6GCiV9GX8ObK5K9uVjZS0Ltpoy1z+zq5cKi/iq44rEjK1og5bCi8vlzJPLAUZhZ7MsuILR1itW0EEFLJF9ItKx4rjFazKDI+dmE5y65l4M8DT1zCFscIqrEAkk7ruxn2Nvtd/s+VgAyLGWZWo3Rkdxb8g5KJjpjLocU0xgpnKkHokqPKLuszHVwT4DaWsMOnvipOStfCqURnzqTnlx5kw6/lsXKajrnIqYacHb/eP3r7BSO9ib++g18OnQ8THwT7Vs4klJvMWAxEV2CDWQu5TSM6WhmtlGt+07hbq0APVMTi/M8kkuC51LNGSynx3R9S3ltWRvSwlEQ+MAeFI+NpHPvHCko+UdYitZEw2T/W1zNKk/eNqTKIcBN4rErXMHbPCHqZaRUMD1SGhYpFjLAyxjBUiLwxSg0nW9uZ57ZnwhSXaG+K1TKCv128vKEMpYJDFoHW0NAdmBbrQKdaLegncwQ66h63aVrL/an1nc2vwakvKzb9ubWy/7O8M5IsX6zsvd3Y4TpW1cqimY1MaI8cLrN8ojfCJRVbE8AglAXZr2J4FYOZYkjqV28d9wDS+wv4U1H5uo2aQVxC2wC4oXu+diq1tkUk9rHhcDueMoKMLSiZdZZns0xBtz9DcE35n0uE920DIzP2Dw+7F8TlGzg7+eXHQwyeitYAyuhrRmlBYQlTEwigUzqDAF0mVL4M5VNIWzwPV51BIhr0/TEz9Nzu2MCZiayCrzGFF4L5kxTRpX4ymUyn2QEw8TduqvQYwgbFcungk+tJiQaF5+vNuHKvSRcfBks/FCGhMmWdt0U2SlJSUmUA2gijWjwmVyCTx5ZQIDCqkMoTBxlxUfiOI1awvJqac9cakmBxPO4WSA5I/Hifd2FUQjtWczsImWoKIwT+Q2VtuVrrzKaOxScfayRhaYH8Zw4worjEqEyExZ0UoR+Qui8Kj63lNxaISWKvF5e7EC7PvCn4Wy8p+Rd6d0r4asWrNg2sVks/WGxbqMnmjdlOoSHhIavPiMKtxV534YpCqLFnl7ip3V7n7lbk7//AsdE/hKUOfjUXoc6GnEOQC9DEcPbpoYCbDm+DINcDTGiL98v4cif0Z3Srmq5uSIO0PxEd+K18Qvtv4w4/3CX40zprxBQnIdvQaDFCJVLLLck8kZkN5U71Y5HZYmH6KANVLICKqpiG0LSRMZiqtSRJp1wBSldVPnBhJ1EeJjLDWV0DiqpPId3ErJLlCkqvdaLUb/TS70QpJrnJ3lbt/ztx9EEk2UnG2BJxkqzyXZuwjLTz3h8+YIOpz/MnJPLtqHq0QMdFgrNYscmj1Nzf6G4PtWG0lcit59WJnsBm/2pQvtze2N/pbm9ut6b3+cpLHTZLN5tSUv70f2cQAcdfAcZWmI2FXFMns8R/Ma9SAT8zdBBLDdwBwd1cNdtzcWcSO50UhTqQe1wjJzmBIPbER1TTMzWmuqediQv1jEEpVCrkolNJcgYpB0IgszVNOXtKCflkaR92Bgyo+Ueoga7iEM2vLlSArCDUXCKwUSqoBYT5QYAQ7RHX+geg0uOi7kLw4I42PSWNxcBMrRYneIPeXy853jyC8oRrR8w6+56DXdztSIwDQEPia1eDOFT5f4fPVHr/a43+OPX6Fz1e5u8rdP2fu/gf4PKCh+/E5Jnw1Psfc9rposNQhBdf/HKZzqgQJOLxFEfMVg2SCwRlXIJTCLS2+LkUXvlqdZRe8Orf1/YE7zPQtgBeuMhkWjZwr7W6ncwufwVd3bVmm7XqJLr7QdY9OH4ZaUoPosoDPN5oguqdHocdos5VNSoHsqx4T9zZnvShk61s+D1Kub/rwXQ9PZk0g6ENQ8TBdhUFH8cTy7DYH0YJ+0OvCZHffr4sndI8uy8z3IDfMF5B0TkVS4WqtueHXI/jtuS/c85tsKdSybS4we0fTNsVrJQ1ftqFfMZ7+8v78mRgS6OSkryzhXZVSl4C0OUWIcFHr1if6tIj3GVNUwxEL3p35zYSSSAwyKCw+6J5S4vIoGOEtqv0ZyjOblBYprgi06upp7Z1EXauMNsLZu1+dNNEdWKgjZ9Y9402Pu4NU42POo+0POhL7KdUivghFc4KK3OyJy7LWS07p9a1C/KWmFnlqEVOzz+ak8Ka9jP0dnBiZTCRkZtla38zc04um6FErhRGiOi8DWSLIMftLV1x77ZvlmKEXEb1ZOT7o96MUO+rsMuELmLDYELNEHIl4VBRW/V0ICh1Kg8thhSz6ZrG+ENOIMyLaXJ8SKfIsozQCPmT5jpEY2geT7NP+zPCkAHLzV+aM+MieRc5/5It3H2d05uFLuszGd9Fi+80yE8OIGEa+Btggv9+lKLCQ26QD1wEfAHsT/3MlCIJO1T1Pa2lVZ/IdXkNbQwxRmYotd/2X3UmBC58EP6DZzRy6CQh43fz2h+8i0KKtasZY9cHAvAUX5c0K7JBzdvPyNgdTtGv+0fQljbuT85N3Ohv/6Cp9TyX549Td/1PFW1Wan7HSBMBL4cZsQ2cwHeSvA15bPM+jA+eRwl885VxlbI3OhXsxRjHThMpMOopqzup4xK8vGFUq6Qj7rVFkFTlnIpp2Sn/0e0xoaDAHaWuBSWU/zegtBjqrrjlLThgPLMmv9N1W3I4Qr3iEzlK1xXs0ZzqGW6gxo9sWePapCB1aD545JceK/drZAF15Xmm65w6xq1xIhNQjEZGkNq584UKfplVti4KhX7OqzmIKNVKhzS2Kye27AR0yo3+dcvwjvOB3G06YYXryYniFY6LImcrCiyRrc7D9MdqItmikspJaQ1RdADA1xeHk6HyBIohpC73Qghdm2AmLbIfmggi1Rz58XrQ32usRtwsYLwvr0MxOEX+jnFj2isZ8HN5ODte/87WYsIUQ9u/w3X8SrPK9iO8BL1vLekAs3W1ukaOtGEEXmnt7Swcd1BXd0bB/w4ZaQ1iXQh4d5gD5rh5Q6OlZuOH/TPx336lZqvtnRV0/vwoUmvoWv1tT92tQ5grT/HkNa+ZX+BOdqVULv3kQlabLfnNAYSTv2cjDB2J1d/dviazF1A==
|
|
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 'Get MAIL FROM Attributes' (get-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 Markdown from "@theme/Markdown";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Get MAIL FROM Attributes</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/mail-from-attributes/{identity}"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Retrieve MAIL FROM attributes for a given AWS SES identity.
|
|
|
|
## 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":"id","required":true,"schema":{"type":"string"},"description":"Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status","example":"bobsmith@sailpoint.com"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
MAIL FROM Attributes object
|
|
|
|
</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"}><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> |