mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
83 lines
30 KiB
Plaintext
83 lines
30 KiB
Plaintext
---
|
|
id: put-password-org-config
|
|
sidebar_label: Update Password Org Config
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW2tv2zgW/SuE9kMfiJzYeU38ZeEm6SCDdJLNA8UiCba0RNtsZUpLSk09Qf77nnspyfIjSZt2d2cKI0BgieTlffPca/ouSDNlZa5TcxQH3SAr8lPp3G1q4xM73E/NQA+DtSCXQxd0r4JqTPiRwq8MbtaCWLnI6owfu8HFSDvROz0SRRbLXDmRj5TIqsWpHYqICYhBaoXLVKQHWsUC/5LYtcQJptvySdzqJBGflMqwTg+1kYn4LJNCta7NP9NCjAuXC6dy3uJDhKd0fGRcbouImHGHRvYTFX/w5ESeiusAg+o6oM99JWiYPhZOCb98yqluEGqJa3Om/l1oC3lOzn79V+/g3dHvayymTUEDosgiH4HLP1gtwkVQrkgH4oWOTbciGkL80IvfvbU6Vy+gYKeiAp8nUPJdcOmUhYJz9SXvgSAp/lECwc09LGDBm3L5mzQGlTt+BKswKkm7FkRE0OQ0JLMs0RHzuP7RkcHuAheN1FjSp3ySKZgw7X9UUQ7WMksukmvlaPRBBTeW9lOoQ5pg3iuOTEzbQk+3I8UmfkzfYqBkXlgl4ErK79ESFzByrAaySHLvBTQ6kIlTLd6OR4Iuv1kL1Bc5zhLlVXCPcfhPfpF+UuZ7mL72dOAzIAQ3+m/yeVCG2DttitxboORXw5xDZUENMTSWuX+12VkQgFkpyZAzzrOvjRh76g+wvU0sY4oeF+Og28Zn+cV/3tloyLLdkKO9MSPFsTJD8uPnMZ/w6iWsP8Dvzgy/Ow1+2780+N1p8Lt3D35zndPnYDEB3jem3i3zIh9ij5it3bm/pz2QOzL4trdkZ2OD6c1IfKYGyioTcU56IG2SgKt4XsXzKp5/RDw/EgJfEddLvXB+XaWwHZ8FtpYF/n6iEc/i0Fr4ZijOFJzQABTpAaeB8ngXfZzvpBVtoCAd/8BUEKtc6mQ/jVVjLpSizXDBjm+1UeHQSk0cKmY5wkIBip91jBVinFqyJZEkU5MIPI8YrpVPmmi1xRsZi7NSvv1SGDKgldEn0DqKn2bo0misF9USoWPGlg9sq3aV7O9s7HW2BjtbUnZ+2Wrvbvf3BnJzc2Nve2+Pdh8r5+RwJkaltXKysPWvyiirI5GkESzyBxRilYTumQHeHEsA08buaRswja/QP8cRz63FLPkVBBvXhBRv9k/F1q5IpBkW/F4O55RgwstzvDFFkpDf1unKEz5htL2MFWUo+K6Cg8O3vcvjC7w5O/zH5eE5PhGthWqgZ+CtVdaFL4zSW+a4FOBWOgD4BOqgTPu6pPoaAknjmhO1f3ITB2VWeQIryt2XrGiSFgOLo6kZSpHH2OKlbqnWGmoBvEPyikaiLx0WwIQ0/XUvilSWh8elJl+LkZKxsq9aohfHmoSsahKH9RMuKuKYQtcTGBR8ntxqFAdFLkya60jN2mKqyllrTLPYcdMoFBzg/Gk/6UV5AeZYzGYU1t5SsljaBzx7zc1yd9FQGqt0YnKJVImZyQRqtBYaFn3IpnMnynRE5nJIPKaaV2esZnLmdPfOM3OQpzwWycJ9RdydJkg/IYtWD3xWZfA5gk8+G7E1KjOVGanEVry4nFWbqwp8XzGuYncVu6vY/crYnR88K8udcpShT3sR+lyaqnECIRagj4fiJp3rrnhDrlHbpYRIv72/8FCSofuXjNofPxAf+aN8gflebQ//vk/wozbWjC2IQdajl2CATKTiLvM95ZgV5VW1ubjb29T2NRzULIGIyJpWTNJCSKjMFsYQJ9KtiThVzrzIxUgiP0pEhHM+A3KJE4dZCrS+QpIrJLk6jVan0c9zGq2Q5Cp2V7H714zdR5FkzRVHS4mTXDEeSzvxnlaOk7RSYIKoGu+iDjk21TxaIWKixljBLHII+p12vz3YjdRWLLfinc29QSfa6cjt3fZuu7/V2Q2aZ/3VNI7rIJuNqYa9vR1ZxQBxn4HjCgPncnmaxrPtP6jXqgGlNUo9NW6GzqHSmxo7dvYWseNFmop30kwqhORmMKSZ6ohyGuaOaa6t5mKCFEPkRSOQqjT4IlfSYwUqFk4jEj3WedUsB107CXuDHKL4QKmcrN5FmygpwCFngiQl1JzCsTSEVAPCfKDACHaI7PwD0Wlpou9C8uKMJD4micXhl0gpCvQauW8v6+8egXlLOeLcG/iBRq+vdqSBA6Ag8Dmrxp0rfL7C56szfnXG/xxn/Aqfr2J3Fbt/zdj9BnxeoqGH8TkmfDU+x9zWhqix1Fv+7v9/DdM5VEoO/GWFNIoKy+3mCoMzroArlbcqKYdIugIQrC+5xxfQDUBChZ6hwiaYOMrzzHXX1+9gJ9jnviUz3UL6gqnyiUlvW1E6Xu9DOUvyDl0Q8DFGE/iOot+gxZq1mpzXZzom7vVc3qQIHPTNPeFHKRs5ZgNO0gK5jcmsCTh66Uj8GixmqCJeOJ7dYsdZkA9yXdrk/vtl8YQekGWZ+h7dDfMFOJ0TkUS4mV7YPCfI7XdfuLY5PUaoTFu8DHNC0zrijZIW9YD/5uLlb+8vXokhAU0O9MIRxlWabypJcQoX4UTWq7r4tIjPFpsWwxEz3pv5noQCRwwSCCyuzblS4uqoVMLvyPBnSMmsUlqkOAvQqpuXlXVi9VkldPi1ppokx9OxWYeG1uXMuld80HFFoI2/C4S3rWsTigNN+cffBMOcUkQu8MRVVsklG3I9l4m/VdRCTy1kau7VHBdetVeRv3cTIXqJhEwca+vZm3t6YYMelU94Q1TneSBNlHzMfrsVVVZ7Nh8z9EKiN8vHtXk/0jhFZ5cJn7SEwyGYxOJIRKM0dervQpDrUBhcDQtE0bPZuqVNQ46IsLPRYCn0W4Y6BCZk/o4RGMY7k+zTmcyQJAVaM7EPyQ9sWcT8B1TMsfgwIzO/vsLRSTPjNHLP5pk2DGnD0OcAV/LvTyZyLLr5Bhn8lUp2gP2p/TkTlIw28p6ntTSrM/l1XkNHA90jZyou6/qH7jTBVffleIBm13OQhglS19/34VmUtOh4mlFW1QyY1+Aiv0mKU3FOb57fuhlFJ+WfTV6SuDftmZyYZPKjs/QDmeTPk3f/TxlvlWl+xkxTglzqPZ5Nf3py+Kx7td9w4XZj2b3aPTBCfs/yl2VJM9relMBxsZlI3e6Rwn+MctJgYI+yiQtBhlNNQlkicwovTi/RSCtuQ2RK5iTAGrl4OuaUkNmU8pByntDQYg7yhwM4ln2dgB43yqudJUeuR7jkYPTsCq6FaK9ohLJWtcR7VIYmgn9QVUhXPTD2MS3Lw3O4yCl5mDiovA7obzwuDHajBFGMhYRvP+GasXYwHSsD1YlRlS5SxqD1qiqdkM+TCC2uj+zYnQyow43iueGBT+wFB3RlexuqJytSuUClVy3ImUrYE2jebP3wFG24fThSSUZ1KdI/kKBq7PDu6GKBIogZB7lQ/6NGWy8XuXWaCyJUp3n32Wy1Wxsh1y14n6UuRyXdIH7JP38T9c/mTuxQ1D+qm/HEu2lvf/XruW/99Vx5gFPltZ5Rr5CsUfhK0FfdV8Gyqht13Ag2o+G7O+omURl6T6+Rz6hVcXUzrTDpCWR9V4nL9E+Kuhnl1xjhxYThSNm2WPx+hgpfv8J3qh6de9PoHpxekof2y9/1jX0fxMpbvKT/3eAaf3hIMx8f9OM/en8XVF1FzPFkK9i3DPWUH0jK+/v/AKWIbgA=
|
|
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 'Update Password Org Config' (put-password-org-config)"
|
|
---
|
|
|
|
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"}>Update Password Org Config</h1>
|
|
|
|
<MethodEndpoint method={"put"} path={"/password-org-config"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This API updates the password org config for specified fields. Other fields will keep original value.
|
|
You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions.
|
|
Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'
|
|
|
|
## 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={"customInstructionsEnabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicator whether custom password instructions feature is enabled. The default value is false.","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"digitTokenEnabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicator whether \"digit token\" feature is enabled. The default value is false.","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"digitTokenDurationMinutes"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 1` and `<= 60`"} schema={{"type":"integer","format":"int32","description":"The duration of \"digit token\" in minutes. The default value is 5.","minimum":1,"maximum":60,"default":5,"example":10}}></SchemaItem><SchemaItem collapsible={false} name={"digitTokenLength"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 6` and `<= 18`"} schema={{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Reference to the password org config.
|
|
|
|
</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={"customInstructionsEnabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicator whether custom password instructions feature is enabled. The default value is false.","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"digitTokenEnabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicator whether \"digit token\" feature is enabled. The default value is false.","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"digitTokenDurationMinutes"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 1` and `<= 60`"} schema={{"type":"integer","format":"int32","description":"The duration of \"digit token\" in minutes. The default value is 5.","minimum":1,"maximum":60,"default":5,"example":10}}></SchemaItem><SchemaItem collapsible={false} name={"digitTokenLength"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 6` and `<= 18`"} schema={{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"customInstructionsEnabled\": true,\n \"digitTokenEnabled\": true,\n \"digitTokenDurationMinutes\": 10,\n \"digitTokenLength\": 9\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n \"customInstructionsEnabled\": true,\n \"digitTokenDurationMinutes\": 12,\n \"digitTokenEnabled\": true,\n \"digitTokenLength\": 6\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> |