mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
81 lines
30 KiB
Plaintext
81 lines
30 KiB
Plaintext
---
|
|
id: get-password-sync-groups
|
|
sidebar_label: Get Password Sync Group List
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW/tv3LgR/lcI9Ye7LKz1vrx+AEWxsZPAh+Ti86Mp6hgNV+LuMieROpKys2f4f+/MkNI+/Ugu6F3SLYrWkcjhzDcPfsOlbiNdCMOd1Oo4jQ6isXAn3NobbdKzqUpeGV0WNtqKHB/b6OAyql4yfMvC66utKBU2MbJAOSDlfCItG5wcMyNcaZRlnGXSOqZHrKgEWBQwJgFNNmBO/yoUu5Fuwt6evvrP4OjN8c+Ml26ijXRTBvKM+K2URqQwlCU8y5gLqzRBPyuSEgeCjrfRhRXmUCsnPrkBSEC9ZaoOqqVjXDqmpeOcKz4WuVDuwAieRld3YEzBDc+FE8aSOIkm/VYKM4WFFLyBf2Yyly5atvsN/8RUmQ+FQVONsGXmLOrrcWi+V2dCsMt/dgmcM8dVygGKQ51lIkEZ7KRe+urHiXOFPdjeTsW1yNBNTctlVmipXDPR+TbYtM0LuW2DnDip5cQzE56xkTYs10YwqeDPnJyNmFWARgcjnlmxFYlPPC8yMK+z0wJIk4nIeXRwG7lpgTbDumIsDMz0Yvyjbgce5FLJvMyjA5iX80/+b5KSihEHFOhfd3db69HUo5EVq3C+pcegNiDoJoKNSvC6R5XBiya7sCUEwpTZQiRyJCE2KIAa5J0GAl/wsVTcCZgP/h5PSE5wzDfjjj/gjBr++8FPdKlWsT8esYYzpWgw6QBVAL7QRZl5KAVr/Cs+145n8SHObiCkhVZWsAlkEYQ/+QEHrkmHCQeJusxSNhQhM8BzclT7DfBjDR8TDXYjEKqxAsRS8Bj4TKpEUDUQ1kk1huLiUBVGhkBpUGzCrwU8Bh8RODhe5gVP3BZaQ7UEPAZZn8LCSjuMFCtw1QYJ+TtZ3kCdSNtrnpXCo4CjQe3SVtp8ExGE9qwJoqHWmeAqmosTmnmHVbByqcUJnVYL/28xRgYPV3UQm2AVhuiCqbwoMpmQrtsfLc6/XVWIG8MxNKUTuZ17rocfAQd4URjEzUmvlUznxlhnIBpWA/kIFcRQnOkWzUET9ff22qN+tx13h+lO3Ou0u/F+srsT74nWTpJ0RXcnTaO7Kl2WMfgZnq5dYFmr2YJr9lDWxhUqFE80IDU9/izjag8UNHlhwU6y395r7aW7vd6QtxLRau/2+qP97rDfafV2WrS21aVJxHFq13hjcc3Xyz73eyj4nkRYdnxk17gwWHA3p9hlpVmv32+Nejtpv9Xu99u7Kef7nXZrZ68Hch4eAmF5BSIT2LydeAJg5wBVikUMa4yTufAsYuY5dsMtq8TNFVecFOOERWRbnW7c6sbt/nmrd9BqwX//jZUVNio+rBIP9Mt1SvvT11Iw4+CDWuhXUhP0dNIthGjNAaM7/M9W1FtXBw4zCUnOXhgDhSlmp3Ml3W+3VKrZUKdE5KSCeirTL6kP99SBVDgopIc6FY8D/FIqAeSPS9RQkMoJTGQg8VqmuJ9QafUiq+yicc0FTAGJZps95ynY6+07DMYgjoYnv4Ksp+TwhZIwn1VTmEypwN+zrNgVfNhv7Xd6o36P885er727M9wf8W63tb+zv4+r58JayMjHU/mVUMLIhGUaCLX8HQCBwAfsSQFa/Om1mGQ8AX8McD+2NjPoy5Cwb8G+/fzwhPV2IcjVuKTnfLwEgoovztblmRf81sixVOtUEQp50WV09OLl4OL1OTw5ffHLxYsz+AtlrTQyAwXRmmJYauIwE31DGgcDMBWtwC0a2ABrBKkNMIgrOz9Q2rBBWACThc0WZoTV18yYF81GRucLqZT47ob9KJuiuQWEBMsBd8mEDTkwEwYuJJY2SBJRuPh1QLIR6Nkz6LjSVKKRwJuI3ViYP0Vmw1MkRVIFxg2pLIjN6dIh+ZGJWPTFDMpFb8yKyet5p2BygOaPx8kgcUDuKSYWsrCOlqBi8A/o7JFb1O58DjSCdKoc8ECZUN+QaANMECoT2CaBmoZyhO6yUHhUNa6uWPM1ksrdG6/MkdP0LuGlfULenWRQfmIyrX5xLULyUcPoqxF5o3JTqEihF6LJYVTtrirxGWwLWbrJ3U3ubnL3ibm7/PI0dD/hLVGf9ir1uVDhjAo3zxXqYyh6lK4Osn4nehMcucUAkECRfnp3Hk7AYLz4VGAX9xX5kd/K1/RvlT/88yHSj9pZC75ABQlHb8EIKpFID0jvmcaeJBJU3dXVXmozlBCgag1FhKpp2FSXjANkplSK+nq7xVItrPrBhY4eMsJaXwFxVZXGvnneMMkNk9zsRpvd6LvZjTZMcpO7m9z9NnP3QSZZa0XZEniSLfOcm6mPtPAereUMBsx+WqlTjly1zFZQGKs5VrTIHKJhpz1sj3YT0Ut5L+1390edpN/hO7vt3faw19mN5vf6y1ke10m2mFNz/vZ+JIiBxF0DjysVBJd1WqeLx38ArxEjLGtYemreDJgDpFc1d+zsr3LHc63ZG66mFUOyCxxSzTDCmgZjcxxrqrEwgLMx1EWFPwlJ0AtDCc9WY2bwrJV+d8LkRStArpnGg5EDU8KvWSHI6lWkSrISNKRKkGlkzRoCS+JPQyPkfCCBGOwYqvNXZKfBRX+IybNTtPg1WsxefEqEwESvmfvOuvPdY1DeYI048w6+56DXdztcQQBAQ+BrVs07N/x8w883e/xmj/8+9vgNP9/k7iZ3v83c/Qx+HtjQ/fwcBjyZn8PYZovVXOol3bf5X9N0SpWgAYU300lSGjpurjg48QoIpXAfFGsIx1uU0faaG5R41cPzfq9RaTIYWd10ugVHgYPumryQTahf4Cs3VfqGrjtdd9eUHbwf4FMMClda+ktUeLnKL9IkeI3ECPbljhbwYIcrTFF9q+pB+Src3JnqEgocidliEO0hmugxqFlAK/GDpdFNip4VG8G2C5PdPWZPuCR2jx1eyD12rIPvwbVgPAMtl8xD9a9md2XPkHP71VduzM72EezTOiuLvcVhHfZccAMNgf/p4sef3p0/Y2NkmpTppUWSKyS2BpArJxAiVMkG1TE+TqLNZXY1c7DwQwlmDhtlYDALN+2OAwg/Q4k/hZpMkOIkQWUAZz39nh1fmHfPvbr3KmZH0vhreJbGBBP93cPLorKLz9n1pUr8rZIWe2kxSbPPlrTw0F4m/uJNAumLInhmCa0vXtzLi+fkYf8ET1Dqsg6IRNBj8eetpPLaF+uxIC9GeYt6vFfvJhK20cVpzFctZid0ufSYJROtrfgHYxg6mAaX4xKy6IvVusFFY8qIuNOaUyn2S8YyBlJI+r2GxFA+mPgQN2XiJBromkp9Sn4gz0LOf6CrXh8WbKbHl7B34shUJ59xeXRJZ1wwxgVjXwNs0N9vTRhYeH0MbKA64APgcOZ/qgRB0bma52Wtreokfpvm4NaQgKokxRYH/h8HswIX/mL0AkfXY6AEI6euf/DD+/5BFu5PC2BVpwHLCK7qm2nYFpdw8/rWp1G4Vf7V7EWLB7NDk7cqm37tKn1PJfnr1N0/qeJtKs33WGkCy8Vwo2VDOzAf5J6trR7hWfr+Af4X3lKmEp2GZmX2ycO8mCLjDmOacjqZSEHNfyG4Q+a3hXGlc8pDoLuY/NDikaAxXUE2oDCHdk1mIK/J3kF3pRKAGDsrvC4BUj/q0GKdAcon6CR2VDkOCFSelwo/oAIlypxxCI9HvJtKm5S+CEGjpURlmSYaV8+qMhLDBqFoUo9hcvt2hKfE0IDOOfGRtcCHNhwRA5DokfBpysyQU5FRlOG4Rfr9mGyInHgisgJ7O6igQKbE3Apvjs9XJIIw5e+yN7UZb4dJdhvHghBsdXwwdJvQ0dHFfW0dNKJzcl8Jx9bd88fL88tBdTs7HP8TvpwLOwhS/+0CT6vQoNK3Ir7vu4zW9n3QSUzAbnx/e4sHGtgE3eFj/4ERdoPgBIzz2Rcp9xr+bX06txa0XwUeEVRfBoZDgCjCjvHpOPx/ffP2AI71N4FfCOTmA7Zv7wO2B8Kh+kpxFg1XsxMUqDX4FZB3HRUeP8kfrM7NWvnpEaXUh12vXuBmwO+h1uEPXOru7r9GrG69
|
|
sidebar_class_name: "get 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 'Get Password Sync Group List' (get-password-sync-groups)"
|
|
---
|
|
|
|
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"}>Get Password Sync Group List</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/password-sync-groups"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This API returns a list of password sync groups. A token with ORG_ADMIN authority is required to call this API.
|
|
|
|
## Request
|
|
|
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
A list of password sync groups.
|
|
|
|
</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"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><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><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\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 }\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> |