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: create-password-org-config
|
|
sidebar_label: Create Password Org Config
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW1lzGzcS/iuo2QcfRVISdUV82aIlOaWUHGl1rB8k1RqcAUk4Q4ABZiQzKv33/boxMxweOtZxsomL5SqZHDQafeNrEHMf2bFyMtPWHCVRJ4qdkpk6ld7fWZecuMG+NX09iBpRJgc+6lxF5ZgII3mYHN00okT52Okxf+1EF0PtRff0SASWXmRDJcblZOsGImYGLXFp/FjFuq9VIvAnTby402kqcq9EovoyTzNxK9Ncta7NhRU9JWQvVSKzTEFs49xndjTlro3PXB6TJL4hJjYXI1AIrzIm/xToj2pUh4Z4Jp+CAMT7OsKguo6w6Jn6NdcOKpyc/fif7sGHo58brJmzEMM6IfNsaJ3+jS0hfAyTCtsXr3RiOqVMTWjcDBp37pzO1CvY1Ks4x+cJ7HofXXrlYNNMfcm6YEi2fpJBdPMAozvIpnz2zibgcs9fISpcSdI3opgYmoyG5Hic6phlXPvsyUf3kY+HaiTpUzYZK3jN9j6rOINoY0eBkWnlafRRg9Wm9izMIU00HwhHJqFlYae7oYL53ZPuEn1ES+6UQPSosEZLXAznIoFG+zL1qsXL8UjU4SeNSH2Ro3GqggkeMK4HOruwvyjze4S+DnwQGmB0Hf2hch4UWfVBmzwLHijk1XDnQDlw61s3kll4tNleUIBFKdhQMM6Lr40YBe6PiL1NIoNEj/JR1NnAZ/klfN5Zr+myXdNjY31Gi2NlBhTHXyd8yrOXiP6IvDsz8u7U5N34oSbvTk3evQfIm+mMPkeLNe+hRvpkCoRUWxJm8wMLft1oLzMY5CLJUHHGWCb4v72+Tv/N2ulM9ZVTJuZi+Fh9jVZVYFUFVlXgT68CC+7be1GNKO210Q5VYGtZ4u+nGvksDp1DbDbFmUIQGsAn3ecyUIAC0QMqIKtoAwPp5BuWgkRlUqf7NlE1WhhFm8GCH99ro5oDJzVJqFjkGBMFON7qBDPEyDryJbEkV5MKTEcCV8YnS7Q2xDuZiLNCv/1CGXKgk/Ev4HWUPC/QpdGYL8opQgN3QqhHllW7SvZ21vfaW/2dLSnbP2xt7G739vpyc3N9b3tvj1YfKe/lYCZHpXNysrD0j8oop2OR2hge+Q0GATqG7VkAXhxTAO5G/nkfMI8X2J/ziGkrNQt5BYHNhpDi3f6p2NoVqTSDnJ/LwZwRTPPyHE9MnqYUuFW5CoxPHOLXLBNFGUq+q+jg8H338vgCT84O/3V5eI5PxGuhbegaRGtZdRELQ3vHEhcK3EkPGJ/CHFRp3xZc30IhaXydUIdvfuJhzLJOYEax+pIZddai77A11VMpDshcvNYt1WqgCcEzFK94KHrSYwJcSORvu3GsxlnzuLDkWzFUMlHuTUt0k0STkjIN5cpj/oS7mSSh1A0M+jnvJ3caLUWeCWMzHatZX0xNOeuNaRU7rjuFkgOSPx8n3TjLIRyrWc/CKloKEQv/QOZguVnpLmpGY5NOTCZRKkGZTmBG52Bh0YNuOvOiKEfkLo/CY0q6qmLVizOXuw9BmIPM8lgsc/+CvDtNUX6arFo1cKuK5PMEn0I1Ym+UbioqUoGteHJBVbmrTPzQN65yd5W7q9x9Ye7OD54V7U4xytBnYxH6XJryuAVKLECfAMWNnTuTCY5s0GFNAZF++ngRoCRD9y9jOjT5hvgobOULwncrf4TnPYIflbNmfEECsh2DBn1UIpV0WO6pxGyoYKrNxdXeW9fTCFCzBCKiajo+GZMwmcuNIUmkb4jEKm9eZWIoUR8lMsL7UAG5xUmaYwu0vkKSKyS52o1Wu9H3sxutkOQqd1e5+/fM3SeRZCUVZ0uBk3w+Gkk3CZFWjJO2UoBAlAfvoko5dtU8WiFmosJY0SxyiHrtjd5GfzdWW4ncSnY29/rteKctt3c3djd6W+3dqL7XX03zuEqy2Zyq+Tv4kU0MEHcLHJcbBJfPrE1mj/9gXqf6VNao9FS4GTaHSW8q7NjeW8SOF9aKD9JMSoTkZzCkmdqIahpoR0TrSloQSDFAXTQCpUpDLgolPVLg4hA0ItUjnZWH5eDrJs1uP4MqIVHKIKtW0SZOc0jIlSC1hJotAktDSdUnzAcOjGAHqM7fEJ0WLvpdSF6ckcbHpLE4/BIrRYleIfftZee7RxDeUY04Dw5+5KA3dDvSIADQEISaVeHOFT5f4fPVHr/a47+PPX6Fz1e5u8rdv2fu/g/4vEBDj+NzELwYn4O2tS4qLPWef/v/s2E6p0ohQbisYOM4d3zcXGJwxhUIJRJobD0XEUmXAKK1Jdf/Iro4SLAwSJS7FITDLBv7ztraPRwFBz205Fi3UL/gq2xi7F0rtqO1280lZYfuBxS3M51Nwq0Gvt4YFmmxeZ2mCA7ljhcIxi6uU0QeRueD4Sf5GzliL05sjgLHbBoC0V5EEz+GmGO0Eq88U7c4ehZ0hG6XLn14Tp9/bz6lR2DyiB7LzPfkWqAXkHJOPRL/ZnrP85wwd1h94bbndB+hPm3xNswJkbXFOyUdGoLw08Xrnz5evBEDQpqc6bknkKs0X1WS4hQhwpWsWx7j0yTeXJzNB0MWvDvzQwlljuinUFhcm3OlxNVRYYSfUeLPUJPZpDRJcRmgWTevS88k6laltPu1ppakwNOJWYOF1uTMvDe803FLoE24DISnrWvTFAeaClC4CgaaQkXu8MTVuNRL1vT6WiH+UXJrBm5N5ubfzEkRTHsVh4s3MdKXWMjUs7W+evHAr1njR/0TnhDXeRnIEoUcsz9vxaXXvlqOGX5N4jcrx7X5ONTYRmeniVC1hMcumCbiSMRDa736pxAUOpQGV4McWfTVYt3Rok3OiGZ7vSZSMyzZ1E2AQpbvGIlhQjDJHm3KjEks4JpJQkp+Ys8i5z+hZU7Epxmd+fEV9k6iTGzsv1pmWrBJCzZDDfCF/GFrosCiq2/QIdyp5ADYn/qfK0EhaK3mBV5LqzqzX+M5tDXQ9XPm4sed8KUzLXDlhTkeIOqKBiWYMHX1gx++i4IX7U8zxipPA+YtuChvarEtztktyFudRtFW+VfTlzTuTg9NTkw6+dZV+pFK8tepu/+nireqNN9jpSlQLh0+nk3fWDn8o6/Xry+/Xo/mHXHP+hd9ST3bAmxcPEsMLxvhL0a5ZDCuR9fEfSCDqTqbcSozSi4uLvFQKz6FGCuZkfgNCnA74oIA3E1VSPnAaMAvTDlYTqJv1Cn4tcRHtHkmhq+pxaN7G+D62Ra93jncfUrRIg7KCAKSG41yg7mU7PlISMTpM2GWaA83sGroNIwqNbOMJ6tZZWmg+CVTtLjZcSN/0qfjanTCtWh6Zi0Eky/OqmFI8gjBfuqjKkXOVMpeJbrZPuA53gjh5lClY2oyUcqB6lRthQ9HFwscwcx46IVmHv3WWjHJrxEtmFDPFYJhs4XWkh5Ru4aOuMZ3n90nqvfkTtxAVG/RzYTU/fSMfvW63Atelyu2XuqZ1sZ0zEcOyEMPF/rlq2hZv4wObEhdNYbv7+kgiJrHB3qMSkSnDFc3096QvoFtOBDiBvsXRQcRxS8QzYsJA4nixGHxpxVqV8OMcMj0JO1NrfE/PaHjtqhXvMk3CmcYTt7hIf3tRNf4hy92HNKBXvej5/dReSIImsC3RGzLAEvxgdR8ePgvfRlmSQ==
|
|
sidebar_class_name: "post 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 'Create Password Org Config' (create-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"}>Create Password Org Config</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/password-org-config"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This API creates the password org config. Unspecified fields will use default value.
|
|
To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true".
|
|
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\": 9,\n \"digitTokenEnabled\": true,\n \"digitTokenLength\": 12\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> |