LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e8c6d4aad70eef6d6870aafd342c04847f4cdba0
developer.sailpoint.com/docs/api/v3/patch-auth-user.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

121 lines
42 KiB
Plaintext
Raw Blame History

---
id: patch-auth-user
sidebar_label: Auth User Update
hide_title: true
hide_table_of_contents: true
api: eJztXFtz27oR/isY9iGXmrJuvumlVWwlx6lju7J9MlM7k0AkKOGEBFmCtKN6/N+7uwBvkmJHadrTk1Eyk0ggsFjsDd+uAN47cSJSnslYHfvOwEl45s2GeTa70iJ1tpyMT7UzuHawiVHbhy3HF9pLZYKDYAi0Ms7Oh5eHv7BU/DMXOmNZzPLE5xk8UUx8kTqTaspyGM+kYtkM2oGgUJn0aG6m5zoTUetGIbVsJjUTyk9iqYhWFPsymOM4eBpIEfp6wG4UYy/ZJ48nfCJDmUmhP92oGzVkz/rtdqvT6rDjMBRTHpa8ZDBHkj1jvsi4DJkX+wL48ZEJoYE8z9g8zot+wse5zcK4mdb0Ae5UnDEehvGd8FsgJi28PJXZHER1jwJJD2OViS8Zig3Fp5MBLthFCQwMN86HBxBlwlMeiUykmoZKZXQwA5oKHsA36TuLEj/2UXLZnB0fwTOUuUwFaC9LcwG8eDMRcWdw72TzBCnoLAXpOw9bjvjCoyTENhH09oODfq+/Jw76O7vdyc5kst/v9vnObu9gz993kDmrzVexP0dyixM1mRqyENTM4oBUa3Rt5V6amGbc8+LUR2MA0aIdXL+9ODtl52h2H57PsizRg+3tLI5D3ZIiC1pxOt2eZVG4nQbe7kG7+4LpjCufpyR3D8WsMuSOJ0lorWn7Nx0rl0z5z/gRHy9JhacpnwMJCbrWtfZ48pvwsiWZDxkySnyys2I9jGuwpUAqMJXJnF2PXx8yZJK5bN1lNRR5DV7pbBlDQCNJUYJo4MgnPFrS7SK3l7Oa1FHUE8HgaxCnkUB7EiqPcBru+zRxFN8K+pCE3MNPtsGLE5QReEeGjFT2U/R8sFw+ydGQmQdWMOjZYCBAJgWfVhQe0Bwynk5FxpAmso3RIxSRMGEAFsGDALRjxJ3VF+nUuduuzw0s3vIwFyQ7Jc4C8rRFbqvBp+KO1cfD8mUWNhypHI6rmFKgLMf32u1qRPG8NqS0r6JP2VCSAGPOYKpJnhmN20iQzCDMJc7DQ41aYcUFMfP9YSlIo0GQFKwcwT19BubQFOIWK2yQnt2gfdw4oAUfPluVw/fKnx8VHPBZ8vUW3JC8ofQdelwOvjZ2XbNAY1bOdj2+O6Uqr52z8ZuPw6N3x6cYSFEmMFYnwJORWbfdxv8WjHAhMj0VQ1YGjlJfTbcEGtxQecI1qR9DnbYa4kMncy0VWA3E/Sdp1TaCJq2ud9DZb+/3d/a52OP9oN3Z2Z90JpNgnwft3e4+TpCvM8MzzXIlYTtg0rRI2A/T5qR3MgxbOpKgtweSTiCNNT8xxRFuGgUmYHYchFYdexKVxO4kRoOiA+pvjdXu7ewacSLbgdXuaR5NwC2fjlrFhLB+gARhPBeCKRrcZKFz4O7s7AMLXdpnI4AX61KHIcvylDwyIv2rbW95cUTinUEsW28KGrKS+53yD5K+i9PP5+uTx2HfPAc4DvgXD0frS6oYurbIApnqzMTSdeajYSv89T3MhWRD/j1UcdQKoheF+/hSQyScn65NGGkiyLYETCiPeLbMPCsn4yA0vd40NOQx/8cFnoMTg1n4hzOupuIIUe+TkxwRYgyMgBJLgHlEYcHt292O2+657f3LbnfQ2xv0eq2Dducfxewn8VSqSxlBXIUhy7tB+aiIPzRliKPY8zBGRAKcmm3zBU69tOkbyZqm3X6duc4uAOnuXmd/Z7/XBX4gPUghAK3Nkh333+Kqvrcu75aIJRqx2eq+PqzGwdcQdYWxLOo8HI0v7d695RyenF0dfXxz9uuKlquL0RgafhmdnB+NLv4GH6tdf8sZj87PaoTGZyej5peLq1fF94vh8OLju+Hp8M3o3ei0GrTYPh4Nj2jOi7Or8WFFz36tUfS5HuTS5X4kFSQ+AGritGqGkANQgitPfIy44kYxxZDcl43OAEW4qwFrI+7BVFF60KZnkxjSHDcV3F/VfgcJp2ii8ko6D3XwVebzD9TcXwWNDkOJdjZKUwB+LhuLLE8xrZFG/UViP4FcEPNfqcAA5Y/ETyYnP4SU/OkY8RoyLneackq8BLFMuTxQvJWUXUZxKoo031ow9WtGEKoTsFfch/Wa9R3axaD0Uu59BlrH3wCTrgw2KoYASCrB9YppxZ7gk932Qbcf7PY57+73O3s7k4OA93rtg52DA5wd4oAGs6n7UeFfzanfCCVS6UGE8EAj/wKBgMGA7IkBmvyxJLepA6LxDfLHbML0LZdp+WVY9dhinL06PGf9PQipappTO58uCEG5VxdY5sjDkE+wCasKGLqJ8Fkqp1I9FkWORq+HVyeXFAj+fjW6gE9Iayn1GaqixgOsgi3M4jsT7c0C7iCH15BkYlbZYi8t1ZewIK50vaM030ylCtN+nocZjLCzrxhRJ82CNI4aruSZEhF7LluitQVJGbRFVF+YcMzOYlMoezn0PJFk7omV5Es2g4Ag0hctNvQhkEjCQrQdaBg/pyzZ99F1DYEgB1cWBKLjPMPKlfQWdtJKlE1tVCHkpK4UdA7g/BsAg5flwBwts+6FpbVYFosanG8l1+TusiY0EulcZdzD0mEYzkGMsEN6EJlgbTLTzIYjVJeGwKOKfmXEqkdGCnfvDDNHWUzPPJ7rb/C78xDCj0tLKx/cCut8GtNsE41IG4WabESytS8abHuV6ioc3xQcN7678d2N736j7y4+HNuCkH1K0KezDH2uFILbOKXNcwn6pMLU+1nRydRUjSK3GAjEQqS37y/BsT8Lhf3FlwTLaD8QH5mtfBmkl/ow7ZOiklps/ZUukEGSo1lBAJFI+APiu+KYBGVE1Vue7XWcTiQYqFoBEamuRj+fgMjSXCnkhOst5sdCq2cZm3GIjxw8QmsTAc2vPC79zLNBkhskudmNNrvRz7MbbZDkxnc3vvvH9N1HkWTJFXmLxUk6jyKezo2l2ed0GIJBB1b8NMlKlyt/kq6jFSTGSozlNJGDM+l2Jp1gzxN9n/f93d5B0PV2u3xnr7PXmfS7e059r7+u/Lh0sqZP1fRt9EgiBhB3i7+PKjAuncWx3yz/gXhTEWBYo5/nC9wMMgeRfqiwY38ZO57GGawNCAN2TL9SXrwanyB9mJrIo9ziPPUEwmwjOnMCByElncGhs0Ub6LiBjpvtZ7P9/DTbzwY6bnx347t/TN9dCzr2n4KO/TWgY58hxAoQYv2e0NEH3IHQLAClwBqKEwzlUU9bfbRubw98FkCvgSK7BytOSMQxe8fVvABLulGJVJW4MLxB3wj7pkVf6MDZFEKkwmNEEtAtWpWMBGJSPHgSykiSH+OCgG46d4cBnlQ1PlPYWzmLVF6YA4cUFMzpjBhsTII5iQDhH1CgOugUAvUPrHFabf1H9WA2xhWf4IrZ6IsnBPp8Wf/dWXVK4BhP7WK4uDC6/spxAVMz5wrSCPElMeGrhKAbqL6B6pvtfrPd/xzb/Qaqb3x347t/TN9dA6pbNPR1qA4dvhmqQ99Wm5VY6jUa1/8csZOrWA7IvFnsEVb3KwxOuAJMqbwZ6lT3csr7jHr7XvoPDl6CRExo2MnTEDoVF9/uzbWWhxZPZMteIJmr+A5P5m/f9lbEHDxiavwLopafe5QzDM+PbZLRItmmEs134faNdVY0VJA4nS14lD6dlwcVziH/YIbMFh6xtqZEzXiaF/IIe7q+Za9gLawR1naVhg9PrefX3mPrMES+so5V4nt0LujPgMuF5SH7H6o7qxcIuM3sSzdXq00E1d1dmuwMu3XZK8FTyAbM6Zfnb99fvmBThJnk5rlGhCsk5gV4Ubi4vjEsToLgINpZ0jifmos+w8ZZG3QbFoSwYHajLoRg18W1pFOI72MIyCTSYeNKcXXt0he3IsStr1VJEg1P+mobJLTdvIr8grY5ygekMkfpobV1o1x2JDH60D1W7GOXSOkduy6vpfDaur6XiT8V1FxDzSVq+sUCF0a01545u+2B7yIJHmqS1ndPbui5NXqYPEELUl3kASVh+WiekPIKrX03Hw16LtJr8nGj3s8k7KELd8lNyGIatsDQZ8fMm8WxFn9hDE0H3eB6moMXfTdbdzipSx7hdts1llwzpSsxLhJ/J+AYyhgTn+COTIAkNrURcslPpFnw+U90zfJTY83UfA0bJ/b0Y09/N884oYsT2huG2vJv9iU0LPBtXAPFAWMAh5X+KRJYRmsxz9BaGdWJ/DaNwa0BLzcQFZ0MzJdBFeDsJ1a7AmH7QAhGQF2eGYPvzNLCzakhrKIUsCjBZX7pMs2C3Ay/5Q+auE/+v60XVzysKiZnKpz/6Cj9lUjy/xN3f6eIt4k0P2OksRAXK4/j6lUXo6fvpDdfD2BB/vL9dwBZaMq0JJtn1B3IIMHl2iC9AQXfdAJPKQoQTocsqLoIXScDzGXoLxQvvJkUVFVIBM8QVW6hzcYR+ThAaQwskDsSoWkKfSAgaEC65j7fvMXeQ9qmPFAfpmx4mheo/hbb3O0CNEivbmBHhVEAOIuiXOEldGAijxgH03vCcnypvdwEOMjglChWFhNELEcV3o4miaKgq4YijfRZgOVnyGxrBvLEXGAf2taeQZCoEftShWohYxGWLzVoQvunaINVujMRJnTxFNiCFLA2w7vjyyWKQEzZHzzwTSB2kN7Gvvi+Cli8MYZeC1JFujAd6wwy3Brd8pU87Mq8UGbBkO6rSvvmHT1OeUsVk5vtBItx9BIEk2wZx752qqQWBgykj9crZyB5fHZ/j7UaTPEesBmEiIWA6w9VBkchA4wCP0PKHEA4W3xNTl0pz8f2ZRsvWPONPis5LYqLal4LOfDxs8ByBLAKSTswS/UiYsQ8sD9QuJdzghrFwMfeloO5rRlsylGPDKMYV5YISA3Qe2JfGBSZckfK76AR/x04N/AXvsSJ8TToRO33TlE8hD6GcIHvVsEb+wGED93+Dci47co=
sidebar_class_name: "patch 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 'Auth User Update' (patch-auth-user)"
---
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"}>Auth User Update</h1>
<MethodEndpoint method={"patch"} path={"/auth-users/{id}"}></MethodEndpoint>
Use a PATCH request to update an existing user in the authentication system.
Use this endpoint to modify these fields:
* `capabilities`
A '400.1.1 Illegal update attempt' detail code indicates that you attempted to PATCH a field that is not allowed.
## Request
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","description":"Identity ID","required":true,"schema":{"type":"string"},"example":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json-patch+json"} value={"application/json-patch+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><span style={{"opacity":"0.6"}}> array</span><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
</div></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={"op"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`add`, `remove`, `replace`, `move`, `copy`, `test`]"} schema={{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>value</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The value to be used for the operation, required for "add" and "replace" operations
</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"string"} value={"0-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
string
</div></TabItem><TabItem label={"integer"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
integer
</div></TabItem><TabItem label={"array"} value={"3-item-properties"}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><div><span className={"badge badge--info"}>anyOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
string
</div></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
integer
</div></TabItem></SchemaTabs></div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></TabItem></SchemaTabs></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
Auth user updated.
</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={"tenant"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Tenant name.","example":"test-tenant"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity ID.","example":"2c91808458ae7a4f0158b1bbf8af0628"}}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity's unique identitifier.","example":"will.smith"}}></SchemaItem><SchemaItem collapsible={false} name={"profile"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the auth profile associated with the auth user.","example":"2c91808458ae7a4f0158b1bbf8af0756"}}></SchemaItem><SchemaItem collapsible={false} name={"identificationNumber"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Auth user's employee number.","example":"19-5588452"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Auth user's email.","example":"william.smith@example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Auth user's phone number.","example":"5555555555"}}></SchemaItem><SchemaItem collapsible={false} name={"workPhone"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Auth user's work phone number.","example":"5555555555"}}></SchemaItem><SchemaItem collapsible={false} name={"personalEmail"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Auth user's personal email.","example":"william.smith@example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"firstname"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Auth user's first name.","example":"Will"}}></SchemaItem><SchemaItem collapsible={false} name={"lastname"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Auth user's last name.","example":"Smith"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Auth user's name in displayed format.","example":"Will Smith"}}></SchemaItem><SchemaItem collapsible={false} name={"alias"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Auth user's alias.","example":"will.smith"}}></SchemaItem><SchemaItem collapsible={false} name={"lastPasswordChangeDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Date of last password change.","example":"2021-03-08T22:37:33.901Z"}}></SchemaItem><SchemaItem collapsible={false} name={"lastLoginTimestamp"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"Timestamp of the last login (long type value).","type":"integer","format":"int64","example":1656327185832}}></SchemaItem><SchemaItem collapsible={false} name={"currentLoginTimestamp"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"Timestamp of the current login (long type value).","type":"integer","format":"int64","example":1656327185832}}></SchemaItem><SchemaItem collapsible={false} name={"capabilities"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`CERT_ADMIN`, `CLOUD_GOV_ADMIN`, `CLOUD_GOV_USER`, `HELPDESK`, `ORG_ADMIN`, `REPORT_ADMIN`, `ROLE_ADMIN`, `ROLE_SUBADMIN`, `SAAS_MANAGEMENT_ADMIN`, `SAAS_MANAGEMENT_READER`, `SOURCE_ADMIN`, `SOURCE_SUBADMIN`, `das:ui-administrator`, `das:ui-compliance_manager`, `das:ui-auditor`, `das:ui-data-scope`, `sp:aic-dashboard-read`, `sp:aic-dashboard-write`]"} schema={{"description":"Array of the auth user's capabilities.","type":"array","items":{"type":"string","enum":["CERT_ADMIN","CLOUD_GOV_ADMIN","CLOUD_GOV_USER","HELPDESK","ORG_ADMIN","REPORT_ADMIN","ROLE_ADMIN","ROLE_SUBADMIN","SAAS_MANAGEMENT_ADMIN","SAAS_MANAGEMENT_READER","SOURCE_ADMIN","SOURCE_SUBADMIN","das:ui-administrator","das:ui-compliance_manager","das:ui-auditor","das:ui-data-scope","sp:aic-dashboard-read","sp:aic-dashboard-write"],"example":"ORG_ADMIN"}}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"tenant\": \"test-tenant\",\n \"id\": \"2c91808458ae7a4f0158b1bbf8af0628\",\n \"uid\": \"will.smith\",\n \"profile\": \"2c91808458ae7a4f0158b1bbf8af0756\",\n \"identificationNumber\": \"19-5588452\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"workPhone\": \"5555555555\",\n \"personalEmail\": \"william.smith@example.com\",\n \"firstname\": \"Will\",\n \"lastname\": \"Smith\",\n \"displayName\": \"Will Smith\",\n \"alias\": \"will.smith\",\n \"lastPasswordChangeDate\": \"2021-03-08T22:37:33.901Z\",\n \"lastLoginTimestamp\": 1656327185832,\n \"currentLoginTimestamp\": 1656327185832,\n \"capabilities\": [\n \"ORG_ADMIN\"\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={"404"} value={"404"}><div>
Not Found - returned if the request URL refers to a resource or object that does not exist
</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={"404"} value={"404"}><p> An example of a 404 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\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>
Reference in New Issue View Git Blame Copy Permalink