mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27: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/SuE9kMfiJ13MvGXhZumgwzSSTaPLRZJsKUl2mYrkxpSSuoJ8t/33EtJlh9J2kx3d6YwAgQSH5f3zXNp6i6ymXIy19YcJlEnyor8RHp/a11y7Ab71vT1IFqJcjnwUecyqvpE6CnCzOh6JUqUj53O+LUTnQ+1F92TQ1FkicyVF/lQiayabN1AxExA9K0TPlOx7muVCPxLE98Wxxjuyjdxq9NUfFYqwzw90Eam4kamhWpfmX/ZQowKnwuvcl7iY4w3Ozo0PndFTMz4AyN7qUo+BnIit+IqQqe6iui5pwR102PhlQjTJ5zqBqG2uDKn6rdCO8hzfPrzv7tv3x/+usJiOgsaEEUW+RBc/s5qET6GcoXtixc6MZ2KaAvit4L4nVunc/UCCvYqLvA8hpLvoguvHBScqy95FwRJ8Y8SiK7vYQEH3pTP39gEVO74FazCqCTtShQTQZNTl8yyVMfM4+onTwa7i3w8VCNJT/k4UzCh7X1ScQ7WMkcukmvlqfdBBTem9izUIU006xWHJqFloafboWITP6Zv0VcyL5wScCUV1miLcxg5UX1ZpHnwAurty9SrNi/HPVGHW1Yi9UWOslQFFdyjH/6Tn9vPyvwRpq8CHfgMCMGN/pt8vi1D7L02RR4sUPKrYc6BcqCGGBrJPDRtbswJwKyUZMgZZ9nXRowC9QfY3iaWMUSPilHUWcez/BKed9Yasmw35Fhfm5LiSJkB+fHzmE959gLWH+B3Z4rfnQa/6z81+N1p8Lt3D35zndNzNJ8A7xtD7xZ5UQixR8y2vnF/T2sgd2Tw7WDJjbU1pjcl8anqK6dMzDnpgbRJAi7jeRnPy3j+HvH8SAh8RVwv9MLZeZXCdkIW2FoU+PupRjyLA+fgmy1xquCEBqBI9zkNlNu76GF/J61oAwXp5DumgkTlUqf7NlGNsVCKNoM5O77TRrUGTmriUDHLMSYKULzRCWaIkXVkSyJJpiYReBwxXCufNNFeF29kIk5L+fZLYciATsafQesweZqhC6MxX1RThE4YWz6wrNpVsreztrex1d/ZknLjp6313e3eXl9ubq7tbe/t0eoj5b0cTMWodE6O55b+WRnldCxSG8Miv0MhTknonhngxTEFMG3kn7YB0/gK/XMc8dhazJJfQbBxRUjxZv9EbO2KVJpBwe1yMKME07o4Q4sp0pT8tk5XgfAxo+1FrChDwXcZvT141704OkfL6cE/Lg7O8ES05qqBroG3VlkXvjC0t8xxKcCt9ADwKdRBmfZ1SfU1BJLGNwfq8ObHHsqs8gRmlKsvmNEkLfoOW1MzlOKAscVL3VbtFdQCaEPyioeiJz0mwIQ0/HU3jlWWt45KTb4WQyUT5V61RTdJNAlZ1SQe88dcVCQJhW4g0C94P7nVKA6KXBib61hN22KiymlrTLLYUdMoFBzg/Gk/6cZ5AeZYzGYU1t5SsljaBzwHzU1zd95QGqt0bHKJVImR6RhqdA4aFj3IpnMvynRE5vJIPKYaV2esZnLmdPc+MPM2t9wXy8J/RdydpEg/LRat7rhRZfB5gk8hG7E1KjOVGanEVjy5HFWbqwr8UDEuY3cZu8vY/crYne08Lcudspehz/o89Lkw1cEJhJiDPgGKGztzuhIMuULHLiVE+uXDeYCSDN2/ZHT88R3xUdjK55jv1vYI7T2CH7WxpmxBDLIegwR9ZCKVdJjvCcesqKCqzfnV3lnX03BQswAiIms6MbaFkFCZK4whTqRfEYlV3rzIxVAiP0pEhPchA3KJk7QyC7S+RJJLJLncjZa70Y+zGy2R5DJ2l7H714zdR5FkzRVHS4mTfDEaSTcOnlb2k7RSYICoDt5FHXJsqlm0QsREjbGiaeQQ9TbWe+v93VhtJXIr2dnc62/EOxtye3d9d723tbEbNff6y0kc10E2HVMNewc7sooB4m6A4woD5/K5tcn08R/U61Sf0hqlnho3Q+dQ6XWNHTf25rHjubXivTTjCiH5KQxpJjqinIaxIxrrqrEYIMUAedEIpCoNvsiV9EiBioPTiFSPdF4dloOuG7e6/RyihECpnKxeRZs4LcAhZ4LUEmq2cCwNIVWfMB8oMIIdIDt/R3RamugPIXlxShIfkcTi4EusFAV6jdy3F53vHoJ5RzniLBj4gYPeUO1IAwdAQRByVo07l/h8ic+Xe/xyj/8x9vglPl/G7jJ2/5qx+w34vERDD+NzDPhqfI6x7TVRY6l3/Nv//xqmc6iUHITLCjaOC8fHzRUGZ1wBVypvVVIOkXQFIFpdcI8vohuAhAoDQ4VLMXCY55nvrK7ewU6wz31bZrqN9AVT5WNjb9uxHa3ebC7IOnQ9oLxz6WwSLjXwPcWwSJu16zQ5cMh2vEDQdXmbIvLQOZ8LP0rfyBEbcWwL5DcmsyLg7KUzcTPYzFBJvPA8us3OMycjZLtw6f1T8vxz8zE5ApEH5FikvkfXwngBLmfEI/avJxc2zwhyh9Xnrm1OthEq0+YvwxzTsA3xRkmHeiD8cvHylw/nr8SAgCYHeuEJ4yrNN5WkOIGLcCLrVqf4NIn3FmeLwZAZ7079TkKBI/opBBZX5kwpcXlYKuFXZPhTpGRWKU1SnAVo1vXLyjKJulEpbX7tiSbJ8XRiVqGhVTk17xVvdFwRaBPuAqG1fWVa4q2m/BNugmFMKSIXeOIyq+SSDbmey8TfKmqtQK3F1PyrGS6Cai/jcO8mRvQSCZl61tazFw/0Wg16VD6hhajO8kCaKPmY/nUrrqz2bD6m6LWI3jQfV+bDUGMXnZ4mQtISHptgmohDEQ+t9ervQpDrUBhcDgpE0bPZuqVFWxwRrY21BkutsGRLt4AJmb8jBIYJziR7tCczJLFAayYJIfmRLYuY/4iKOREfp2Tm5ktsnTQysbF/Ns+0YIsWbIUc4Ev+w85EjkU33yBDuFLJDrA/sT9ngpLRRs4LtBZmdSa/ynNoa6B75EzFZ53w0pkkuOq+HHfQ6HoMUjBB6vr3PryLkhZtT1PKqg4DZjU4z29qsSvO6C3wWx9G0U75Z5OXJO5OzkyOTTr+3ln6gUzy58m7/6eMt8w0P2KmKUEunT2eTj49OXjWvdpvuHC7tuhe7R4YIb9n+cuypBltATbOHyXSWfdQ4T96OWUwrEfRxGUgg6kmmSyVOQUXJ5d4qBUfQmRK5sT+Cjm4HXFCAO6mLKR8IDRwGIPs4QGLZU+noNcWH1DlmRi2pgqPrm2A6idblnpnMPcJeYt4W3kQkNxoVBjMpWAvRkLCT59ws0R7mIFFQ6VhVCWZZTxZz6pSA/kvqaLNtY4b+eM+nVajEG540xNrwZl8eVQNRZJFCPZTGVULcqpStiqNm64DnqINF24NVZpRjYlUDlSnGiu8PzyfowhixkMu1PKot1bLSX6VxoII1VzBGTbbqCypKbM+R0HcoHvBX7GJ+uu3YzcQ9bdxUy51NzmiX34E960fwZX7MBVQqxkd+ZE1ilDQheL5MlpUPKMcG8Jm1H13R4dCVEneUzPSEp04XF5PCkV6A9lwOMTV9mdFhxLlrxGt8zGjivL0Yf5nFqpdw4xw4PTo2OvGIcDJBTlnr/w8bxSOM5y8RSP970RX+MOLzUJo0Dd81H4XVYeDGBPIVuhtEXgpH0jK+/v/AAsdWfI=
|
|
sidebar_class_name: "put api-method"
|
|
info_path: docs/api/v3/identitynow-v-3-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> |