developer.sailpoint.com/docs/api/beta/create-custom-password-instructions.api.mdx

---
id: create-custom-password-instructions
sidebar_label: Create Custom Password Instructions
hide_title: true
hide_table_of_contents: true
api: eJztW+tz0zoW/1c03g88pnbaUujSYdkJBe7tDo9uaYcPbeei2EqiW0f2tWRC6PC/7+8cyY7TpC3L3mG5TOjQ2tbR0Xk/ZPkyKkpVSacLc5BFe1FaKenUfm1dMTmU1k6LKjsw1lV1SjA22oicHNlo7zTyQKKBEgtg5xtRpmxa6ZLugfh4rK3oHx4Iv4IVbqxE6lGUDQrdQSGGRcVAtlSpHmqVAW6kxMHzRPSFKy6UEVPtxuLt0S+/9Z+/PngjZO3GRaXdTGCtSv1R6wqzXCFSmefA5SlIwAMNKuueFdks2ruMGthoD8urjSgtjFPG0ZAsy1ynLKDe75ZYuYxsOlYTSVduViowVwx+V6kD3rIicTqtLI0SvSTVFg7caTOKlmWjGt5ApXSgvayUBQVeTDxG4sD/kXKitqoSRk7UhiAwNxegNJmoTV6kF0KmaVEbJ4Z5MSWWlaknpLZ0LM1Ixc2UPayiqvYWgFcBhtpoO8YAYYqtyhUraM9f0XOmKiaqiKg9uoghIJ1jcDKUYYm0yNTCg4uBDPctKmbnBtpWjjcLL4+3pHuZxEEmy/OujId55182WIf7c3O4XZHBpr/ClGHHOUQqBtLqVPx6/PoVAU6gf1LjRH7Sk3oicmVGsHLY7tbm5qaAdiqZgnybiOuWm2qY+wDLSaOd/ux9QH4sNAzEOZleYO7BsOOB+jMbuHDqkwOqNK/Bl5Ai1+ZiA78vlHjSF78evXj5j7Ozs+jk6BX9eZokyZNe/6lI4SEXkIcgFORlTAA8wfAahMUP0XpVBVGKQVVMyYq9HEDMrKjFVGIEF5WfAqLBBNwSrgmOPRci08OhYhw0d0OUuZJ2Dia0I7iz6LdBLs3FWeTJJ7L2xBMpxpUatkxEwkmyXX4QJuBKPKX1n/TkU5LxAj9SGDXFrIGYjrvsAYiloLJEvCmcTpWYqjuVAt/5TNi6LAuEBYjIryKk9+yGahY+k5JEMDoYo8zVKntTn+SkpCH480rz81Nbi1thHhtg4tn+4c6uACWjmmILQrq3pkwNZZ078VHmtSKmSBzhIV2COpDntGMSrk0TxENL6TwO3ureC84WvVOgv5iU0szmEa4sIGbEV+YwUw5RxorBbG6DrY6jusphpGMYC6kSlBPtIKGEEHyA3t7cpD+LUjxSbF/QIOzotixFkXWdLdbZYp0t1tlinS2+b7Zo+G6W/D4JZGdVztjPNdnYi6oC0lgcKVdXBjaoh0Fx3G6IAfoNkpM2EJnO/sTk4RnZp6B5a9x5qY2KR5XURKFikinaCmD8qDMSwaSoVJCNKDwLDJcs2BQkkWyJZzIDv56/RvSkdcQdEufXZLQTozFfNFMEIk9jkSuWVbtKDh5tPt7eGT7akXL77ztbuw8Hj4fywYPNxw8fP6bVJ8pamILtrC2rSs6Wlv5FGVUhnrItcfBDewrZMwG8OKZopyb2dh1c74e3Ol6gl0Nq8Dhx1eWu+HN88g5PTJ3nckCPqHNtg8HbSo+0WRkSQmJ//uJl/+TVMZ4cvfj3yYt3uCJcS31738BaMzJLkApbGCMFuTkDU4Qmn48plt0PWO+DIWlsF1D7OzuzEGYTOTAjrL5iRhe1GFaIS11XYr9B/rmrE5VsIPTjGZJhOqYEiQkhg9zvp6kqXfwqSPK+GCuZqeoe0mmWaWJS5j6AWcyfUQ6RWUau6xEMa7iy4p2GonbCcLRe1MVclIvamIe+V12lkHOA8tvtpJ+6GsQxm10vbK0lkBj0A5q95BapO+4IjUU6M0jq4ELmyDVpUXEeHNSUC60I4YjUZRF4TAPXRqxuROdw99oT89wVPJbK2n6F3x3mCD8xs9YOfFTB+SzlZB+NWBuNmkJECmU5Tw5Qrboaxxeom/Js7btr31377lf67tXBo9Aph1EufR4slz4vi2qgIXWzou7h1pNqdQk1VLUxlN0lasqsUNbccWIs4fToo0CHd2vQrkwWl4U2bl0ercujdYhdh9ifJ8Suy6O1765996/puzeWRy1V7C2hTrL1ZCKrmbe0ME7cSgEA0byIEK3LsaquViuETLQ1VrRYOUSD7a3B1nA3VTuZ3MkePXg83E4fbcuHu1u7W4Od7d2om+tP537cOtmiT3X07fXIIkYR9xF1XG1gXNYVRba4p1XTG4ghhTXecvXv4D9Dd7Q7ef7li68dH67aNjugLT2y0nd+iWv2zyr2MWlAgvpUeq9pK591hbiuENdZZp1lfo4ss64Q17679t2/pu/+FxViqIaurxAB8NUVImCTTdHWUi/Du9DvWyiyqwQK/FvhIuXX99m8CuS6AqZEBJWF9S9s3Rh3Pf/muX27G+vFM6e+BPWk1VWOGWPnSrvX611CY9DUl0SWOkEgg9LczBTTJC0mvQHEtCIC0RtY720EwKdS/QIJy7jSZMY+5jFyL3H/jhkGC8nz/uSNmOmoCKmSDyh4NBsCJh9Mih+Hd9N3LEMnbEJL/IGvkyr/8r/z4hFdw8sq8d24GuAFKL3CIrFwTuqC6oGI9XUCevZ9wOrXpO3T8y7MOyrQPYVLkPOkQ23F9hJBbwlsWzxTskL34M8E3/3X++N7YkRlKYeF2lJFrDT1EXCsQ5gRh71+s+tMkzgTVUU9GjNz/dDE+HMu5Gb+YJQ4M3Sm4PQgCOoN8sERAjiLnSYpjhk06/xuo8FMfVQ5pcpkLm0yTp2ZHqTYkwvz7nFa5P5BG3/AB0+TMxOL583hD392IbDIW+ritGz4kh2+vpWIvzXYYo8tZmz23hUqvGhPU3/4IYWvEwqZW5bWNy/u8cUdfNRs4QlhvUoDSSLQIRe0ljZa+2Y6FvDxgbRFOs7M+7FGzl2cJnyIExYpM8/EgUjHRWHVP4Ug0yFXOR3V8LRvJmtKi8bsEfH2Zoek2C8ZazqrxvS9gmMYb0xyQBmcC5gCtZ3JvNt+YM0iLnzgY2QfFnjmx6dItASZFan9ZpppwZgWjH2csIH+cP4GxIYTgxwHvAHsz/XPkSAQ2omNHtfKyM/oezyH0kcKUhmLLff8zd48CDbHmHiAoFsYhGoqwNv3U/QZQcBFyWxBWM3WwVUJLtObF8ihV+Tm6W03Tyiv/mj8Esf9+Q7LW5PP/uwofU0k+XHi7v8p4q0jzc8YaUJJTDuVR/PvkV6sOAl56ynsxXOPbUvVqeKpAyHDZgZDl9J1p2ehelzeW7R0HlbhN0Y5KnCdjy7Kf35F9VIXUZlLR/7D8SMda8W7EqWSjirRDbLhYsI+X1YFBRplPaIRfxhWQTgSfaTOgY+PmTYrS3ZNX+aSBdG9rbk14m+8WEaJeI9G0aQwAGoS6ewBxn4vQrf4DjZwSCYknjdmhfJuMqkNfTUGsuuJkDDeW2wv0xYNCwsDPaNRjSwKLjLbWU28IKMmFhJul6qJfTukDW/00h0Tu2UtWJgNu90QPWmRD6OjE2sZOVK5bBqmxSbiNtyw63is8pJPE4MsNJ2dFV4fHC9hpOPNFnylKimqUS9Msj2CBRJq1rz5PEi2ks2Ymxc6H4+uD411B/k+a13c+DHhFZO8nO/5/2CfFYY8SA1Mr6QNOuK59k2X73RPoxs7XfRFY2qMAXd5SXs51Pp9oceID7RRcHo+7+q4k8IE3tPhVutC0V5CCATx8YzTe9g0WH47Qs2mn+H3iW6EPe/07odvaccsGoSvJyd+G6KSUzyk33vRGX5wU5SeLfrEkp5fRs2mHmA8Xvr3H3bQmt0=
sidebar_class_name: "post 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 'Create Custom Password Instructions' (create-custom-password-instructions)"
---

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"}>Create Custom Password Instructions</h1>

<MethodEndpoint method={"post"} path={"/custom-password-instructions"}></MethodEndpoint>



This API creates the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.

## 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={"pageId"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`change-password:enter-password`, `change-password:finish`, `flow-selection:select`, `forget-username:user-email`, `mfa:enter-code`, `mfa:enter-kba`, `mfa:select`, `reset-password:enter-password`, `reset-password:enter-username`, `reset-password:finish`, `unlock-account:enter-username`, `unlock-account:finish`]"} schema={{"type":"string","description":"The page ID that represents the page for forget user name, reset password and unlock account flow.","enum":["change-password:enter-password","change-password:finish","flow-selection:select","forget-username:user-email","mfa:enter-code","mfa:enter-kba","mfa:select","reset-password:enter-password","reset-password:enter-username","reset-password:finish","unlock-account:enter-username","unlock-account:finish"]}}></SchemaItem><SchemaItem collapsible={false} name={"pageContent"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like <A HREF=\\\"URL\\\">...</A> clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: <a href=\\\"URL\" target=\\\"_blank\\\" >link</a>. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target."}}></SchemaItem><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"en","description":"The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\"."}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Reference to the custom password instructions.

</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={"pageId"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`change-password:enter-password`, `change-password:finish`, `flow-selection:select`, `forget-username:user-email`, `mfa:enter-code`, `mfa:enter-kba`, `mfa:select`, `reset-password:enter-password`, `reset-password:enter-username`, `reset-password:finish`, `unlock-account:enter-username`, `unlock-account:finish`]"} schema={{"type":"string","description":"The page ID that represents the page for forget user name, reset password and unlock account flow.","enum":["change-password:enter-password","change-password:finish","flow-selection:select","forget-username:user-email","mfa:enter-code","mfa:enter-kba","mfa:select","reset-password:enter-password","reset-password:enter-username","reset-password:finish","unlock-account:enter-username","unlock-account:finish"]}}></SchemaItem><SchemaItem collapsible={false} name={"pageContent"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like <A HREF=\\\"URL\\\">...</A> clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: <a href=\\\"URL\" target=\\\"_blank\\\" >link</a>. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target."}}></SchemaItem><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"en","description":"The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\"."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"pageId\": \"change-password:enter-password\",\n  \"pageContent\": \"string\",\n  \"locale\": \"en\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"pageId\": \"reset-password:enter-password\",\n  \"locale\": \"default\",\n  \"pageContent\": \"See company password policies for details by clicking <a href=\\\"url\\\">here</a>\"\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={"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={"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>