developer.sailpoint.com/docs/api/v3/create-password-sync-group.api.mdx

---
id: create-password-sync-group
sidebar_label: Create Password Sync Group
hide_title: true
hide_table_of_contents: true
api: eJztW21v2zgS/iuE7sNuC8vxW5yXLwc3aRdZtNtcXq7ApcEtLdE2d2VSR0pNvUH++z1DUrYUO02uF9y1C6NFkEjD4cxw5uEzNH0b6VwYXkitTtLoMEqM4IU45dbeaJOeL1Tyk9FlHrWigk9tdHgVVe8YvWTurY2uW1EqbGJkTpqg52ImLRudnjCv0DLO8mqgpYFTGsjG3IqUacWKmWA2F4mcyMRZY1lu9CeZirTNRqzQvwvFbmQxY+/Pfvrn6PjdyS+Ml8VMG1ksGOYy4l+lNFBWaJbwLINGb0EbtluRlCQI+2+jSyvMkVaF+FyMoIF8kqk6rMyLybzYmRfPueJTMReqOLzBeBFd38FTmkrY4pVOofA2qmaODgtTilaUkG5V0Cue51nwZ+c3S4G5jWwyE3NOvxWLXCBUevybSApYCYexFoUUlt7KtCZjCyPVNLof5ZNjpic+dsuYQkh85vM8o3HD/f3uZNjvxv1xuhsPet1+fJDs7cb7orObJH3R303T6K4VKT4XNF1T/S94unGC+1atJtyQHaxLM1ThPdWIyOLkP3JumTm5G9yYsJccdPc7++neYDDmnUR0unuD4eSgPx72OoPdjpvb6tIk4iS1tUm5MXyxNudbaQuadTmjzwDkrFNh2cmxxSCkwtyue3BXM+yqsmwwHHYmg9102OkOh929lPODXrezuz+Ani+LdDrIt1YoyScE7AKhSiHKuEIZSKydq4Faud1wyyp1rWiizZwjTyMaFNOAZmQ7vX7c6cfd4UVncNjp4P8/IKDKLONjkqB0h31znaJqn8/AjGMNlkqfyUzYWciikaIrcKuv222ohY2Z3Is2JfLjOdhIwefKjDtyygibAyw9ZPTwfK2Iz8REGKESQcjYqKZV3Akjt7C1ha0tbH2/sEWF97TCaX1fEDfYhGpHmQRYsdfGaMNidiaK0igkvPSlFygaG4OjETuU6hPPZPqMOJeKgsvsSKfi8QR6I5UAo+SSLBTO5AQDA8PFCOSNQY45lRV6OLl2I2cQiXaXveIp/PX+HQVnKE8MT36Hrqdg1KWSGM+qIUymDOn60LRiT/DxsHPQG0yGA857+4Pu3u74YML7/c7B7sEBzT4X1gJxHoeqn4QSRiYs02Dp8g8EBIWN2DsD3OQbgOqBNXA6nhB/KmAvu3Qz2MuoC2ihOXl1dMoGeyhiNS3dcz69FwQVX55vwhGv+L2RU6k2mSJUOaeKOH79ZnT59gJPzl7/7fL1OX4jXWud00ghW1NKS5iKXJjpG2dxcICgxooM4aDO6GXQ+hIOcfRMNUFpwwZoEUzk1oSXWYERYfYNI+qq2cToeaOUEt8ysR9lW7RbbEzPAHDJrNnEvRwliciL+G2I5Es2EzwV5gXauDSV5CTPGKoRSjF+AUWMpymVrlcwKVHKwvV6uiyY0oVMRHMtVqFsrsYKLN/WF4WKA5Y/niejpChhnHOzXoXLbAkmhvWBzT5yTesuakFzIV2ogifwAl3pAmE0BhFmY/gmC8sCHNFyWQCPquSWiFXfAxzcvfPGHBfavUt4aZ9Qd6cZ4Cd2ri1ffBKh+Cxxw9Bv02pUyxQQKRBHN7jqyqtYVIXPsO1l6bZ2t7W7rd0n1u79l2ehlwtvHfXprlOfSxUOvmjzXKM+xmWP0tXp2B+O3oSFbDEEJFCknz9chGM1yIvPOR1hPSM/8lv5mvGj5Xr452OiH8vFaqwFGeji6D2YAIlEeujsXlnsAuVD1V+f7Y02Y4kEVRsoIlDTsIUuGUfITKkUWcJti6VaWPVDwWYc+MhREdZ6BKRZVRrnWqpiyyS3THK7G213oz/PbrRlktva3dbu91m7X2SSS6tctQSeZMv5nJuFz7TwnrzlDAKs+lSBLUvOLdV9tkLK2JJjRU3mEI173XF3speIQcoH6bB/MOklwx7f3evudceD3l5U3+uvVnW8LLJmTdXW26+jCzFI3CfwuFIhuWyhddo8/kN4jZgQrBH0LHkzYo6QXi+5Y+9gnTteaM3ecbWoGJJtcEi1ihFhGmTnJGsqWQhwNgUuKgaokrCLUonOjmNm6Cw5k3Ppipe8gF6ziEeTAq74QqmSbDmLVElWwkKHBJkm1qyRWBJOiglxPmhwDHYKdH5GdhqW6L9i8uyMPH5LHrPXnxMhqNCXzH130/nuCYw3hBHnfoEfOOj13Q5XSAA0BB6zlrxzy8+3/Hy7x2/3+D/HHr/l59va3dbu91m7/wE/D2zoYX4OgSfzc8i2O2zJpd5Qcv3PaborlWCBS2+mk6Q07ri54uCOVyCVyKBcWwcinO5mRjsb7mXSXRZP/L1JpckgOSuK3B7u7NxipbBCd22eyzYADItVLJS+aSd6vvOpvwF36IKArzEgV1om7ryZLq/6SdouvkZSCnu8cxP4aDuPKFkRdXcy/EX9KlxNWugSCOfUtBjSPaSTewwzc/QSP1gn3Xbps+YjfLs02d1j/vy9/yU/vJIH/NgUvi/OBXkGK++5R+Zfr27gnhPp9rOv3cNdbSTUqPXWJntPYj32SnCDjsB/dvHjzx8uXrApUU1X6qUllisk9QYollOkiIOyUXWOT4Pc7oJEms6c4aPGJyVUOmySwWH2UZ0Lwa5OQhB+AcafAZRdSGmQcDhAo65/rFYmFZ9ERttfexVJSjyZqh1EaIc3xr1wW53rCaTyN4bwtP1RxexYEgK5m9AkE1x0LR67yiu/eM2vrzXiL5W22GuLnTb74p4VPrRXib95k6B+SQXPrIvWV0/u9cU1fdRA4QlpvW8DRSLY0fx8K6lW7avtaOiLSV/Tjo/qw0xiH20OYx62mMU2mKXshCUzra34K2OUOlQGV9MSVfTVZt3QpLGriLjXqZkU+yljGYMVOvveojCUTyY+pl3ZkRINvqZSX5K/upVFzf/q7rL92vDZPb7C5kmSqU7sV9tME8Y0YewxwAb7/d5EiUX34+CDwwGfAEer9XdIEAytYZ7XtRHVnfodN4a2hgSmOi02P/R/HK4ALvzG3AuSXsoAgolULz/xo28RBF20QTWCVR0H3I/gur2Zxr54L27e3uVxFO2V35q/5PFodWryXmWL50bpB5Dk28Hd/xPibZHmz4g0gebS6ePZ6gtEr5/9Am/3G7rAW7sF/tCF59U17M0SCBlVqFup0ELVccET3PVjTzqXnwn8xFsHbq4FQYPnv0RGtK+uJs94QTDgYDCZSeEOTHLYTmS5RaWo5w660CEQXqItdoqmzj+DNeZocWUGfW32AR2pShBN6kbpigm0/qZDW3qOxDylvGbHVa6Dc87npaJvssGIcs44KuqRgkilTUqP22hOlag80475LkdVIEaVRqFou77MzO37CZ2so2mv5f0jcyHtbThWRyBrX5VZOXImMv/tPcg1O5bHdKPY4pnI3K12JC34p6jN8O7kYk0jlCmfsm1tpjthkN0hWSih7tAnQ7+NLth9mQOdJZr3mt4jt3xsQx3dT6nb1ccJ39iXG8N2TH3UTk5nf+Rq6fs630RfRRubaJTnjHptvL+9JWOpo7yjx4AnOnu4ul41jPQX9PpjItd1/y7oeCJ8LhFfLBy7COcQ6x+4UA/rR/ijpy/KXteOA07f0yFcNA7ftpz7kw3Db/CQfh5GH/EPf+jcZx59JZOe30bVOSFkvN6Kxm1iMeEXcvPu7t9sX1cf
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 Sync Group' (create-password-sync-group)"
---

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 Sync Group</h1>

<MethodEndpoint method={"post"} path={"/password-sync-groups"}></MethodEndpoint>



This API creates a password sync group based on the specifications provided. 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={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the sync group","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the sync group","type":"string","example":"Password Sync Group 1"}}></SchemaItem><SchemaItem collapsible={false} name={"passwordPolicyId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the password policy","example":"2c91808d744ba0ce01746f93b6204501"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"List of password managed sources IDs","items":{"type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date and time this sync group was created","format":"date-time","example":"2023-03-16T04:00:00Z","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date and time this sync group was last modified","format":"date-time","example":"2023-03-16T04:00:00Z","nullable":true}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Reference to the password sync group.

</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={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the sync group","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the sync group","type":"string","example":"Password Sync Group 1"}}></SchemaItem><SchemaItem collapsible={false} name={"passwordPolicyId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the password policy","example":"2c91808d744ba0ce01746f93b6204501"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"List of password managed sources IDs","items":{"type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date and time this sync group was created","format":"date-time","example":"2023-03-16T04:00:00Z","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date and time this sync group was last modified","format":"date-time","example":"2023-03-16T04:00:00Z","nullable":true}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"6881f631-3bd5-4213-9c75-8e05cc3e35dd\",\n  \"name\": \"Password Sync Group 1\",\n  \"passwordPolicyId\": \"2c91808d744ba0ce01746f93b6204501\",\n  \"sourceIds\": [\n    \"2c918084660f45d6016617daa9210584\",\n    \"2c918084660f45d6016617daa9210500\"\n  ],\n  \"created\": \"2023-03-16T04:00:00Z\",\n  \"modified\": \"2023-03-16T04:00:00Z\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"id\": \"6881f631-3bd5-4213-9c75-8e05cc3e35dd\",\n  \"name\": \"Password Sync Group 2\",\n  \"passwordPolicyId\": \"2c91808d744ba0ce01746f93b6204501\",\n  \"sourceIds\": [\n    \"2c918084660f45d6016617daa9210584\",\n    \"2c918084660f45d6016617daa9210500\"\n  ]\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>