developer.sailpoint.com/docs/api/beta/put-native-change-detection-config.api.mdx

---
id: put-native-change-detection-config
sidebar_label: Update Native Change Detection Configuration
hide_title: true
hide_table_of_contents: true
api: eJztXFtz2zYW/isY7kOTjCXZshzHftlRbKfjjmN7fZk8OJ4WIiEJLQWwAOlE9fi/73cAkKIuvqa7bTNMZjwSCByc+42AbiOdCcNzqdVhEu1GWZEf49uN2BtzNRL7IhcxPdzTaihH0VqU85GNdq+ic12YWNjoei2yIi6MzKcYvo0urTCYnIuveb/IxzRVJmrX+um7RZbwXETXd1iXCBsbmRF47HwmspRjCsvHgimHA4sdEiwpsWCxQ6PwCLOhNm62B85sJmI5lCJhg6kbHwGGYof77IvMx25kfn1m9I1MMF8q99SI3wthczbQybT9WTH8+6z6LNe/AYyDcXL248/9/Y+Hx4yDOE1UM2ndQmkAKNcs5mkKaBjtnx62wbGMGz4BBcY6BkkiNuNgzVqk8ADfZILPJYxoNzeFAFfjsZjwaPc2yqcZzbK5kWoU3S0y7mLGAQdIfOWTLKUV3Xhn4936u82tZGNng797u76xlXTf9ba2Bj3e3ezuRCSFQPR70EybLaIRkyxVTo94lqUydqzr/Gpp79tlLPXgV8gqWkTSq8sC/6WCBCczWXrNY171WKV74CbPPZt5wrhKWGG9kHkc60LljI9GRowqoUKLrOO8IeXOJdQUCArFBykRdruAW58NUz4CNomjTuHj8F5cgEYA5FDmgfW0XeDAQOtUcFWXhGdlIoa8SMHKIU+tgBwr07M1BnJj+HSJfyflVEbTrNv7y1jG45cgKnMxscuaBYRVMSGL7e/tnVweX/x8ebrfvzjYx5NyZO/sYGFk/+DogEau72oEPwSivgC2cqBymadiAiWzT5GNUwayMVFbyGBkuYwl7EqQNd/DlIel5MSyQkzY7FirGp79HAwbFLl4HsJKq1YN6Zn2VuD+p2RYkWK5SB5m+OGQLQglEGSZHg69Y4OPTROWSpvbeSk4Up9NQ6nx96jlvF5NxGQgzMkQ88uP52MOh/WRy3Sgvzq1Kkl9utg82ffNf5gFT5DrMxmD4CmM4um+jlfgeiS4UWyijWB8oIuVG46FcaZemBQrxnme2d1OJ9FxQSg6T9K24FimpcrbsZ50LOe2MxZp1gngbMc79/Y4n6QkhZeIK+UWCQWiHLzxWCtxXJDM8M3HiQtaSvIyNzIWpwBA/Endius72pO4CuAPJSV3dzTTCJvBk3rhdtfXl/l26XKP5BnJRek0oyYONnGwiYNNHGziYBMH/+ZxsLcq9O2lkiRyYAxcYIudibwwigrf4VLhS+KV6oanMml/S9ybDzqIsuDynk7EKn87j+wHqURrZLgkDIVDOcbCUK6TK3Ey9yChio4EN689V/6CE+0N9h6x8izQtxeIIYYaHv8GWIfJ4whdKon1rFyCMrtqPazYVmwLPni7vtPtDd/2OEfBvbG9NdgZ8s3N9Z2tnR3afYLIzEfi8Xj3o1DCyJilOoZE/gBDEPxtyBPc5is08B4ZOBhP4D81FPzcisyAL6O2zhpi6Pu9U9bbZinUsHDjfLTABNW6PKcOR5GmFHx97AflHvCJkSOpHgq9+wcf+pdHFxg5O/jP5cE5PhGspbZRX5UxBqhCF8b6i8M4EPCFW1Z6wTZ7E6C+AUFc2fpE6b/ZqQUzWQgaWBF2X7GiDpoNjZ7MmVLse2DslWyL9hob0BhSPCQqA05Zm/Ytpzf9OBZZ3joKnHwDj8UTYV63WT9JJBHJUwZrBFCsnwIQ40mtZzUsYMrCdafIBSoN1yrmZTFj5bw0Zl7lqC4UMg5g/rie9OO8AHKOzLoVVtoSUAzyAc6ec/PYXdSY5lg6hV+GW6M+2hRsNAYcZvDmTCLGBHdE4rJwPKqcV3msurN07u6jR2Y/1+5ZzAv7BLs7TeF+Wo606sGNCMZnqc8XmockjVJMwSPhIZHtFi+2GEvD94Gzsd3GdhvbfaLtLj48CwV/eOpSn40VVb8KrXoKnkupj3Hao3TZz//DF5dekGsMDAkp0k+fLsKLACoov2bUI/8T8yMfyldUUaU8/PjAF1KiCv0zWRCCjo+hjwBPJJJdh/cMY8coz6rN5d0+aDOQUFC1IkWE1zRsqguGGoOZQinChNs1lmhh1Q85G3P4R6TMwNd7QFd4Jy2fWTeZZJNJNtGoiUbfTTRqMsnGdhvb/Wfa7oOZZIWVs5aQJ9liMuFm6jUtPCdqOcMEVr56YpXJOVEtZisEjFU5VjSfOUSD7sZgY7gdi17Ce8nbzZ1hN37b5VvbG9sbg153O6rH+quZHVdGNm9TNXl7OfpzIsLcII8rFJTL5lon8+0/sNeIIbk1cj1V3gyeg6XXs9yxt5w7HusctAEwckdzT3vx8uyI4GNrB5745l+HkdE61vkGMaWUpMPgtLR5kzo2qWMTfprw892EnyZ1bGy3sd1/pu0+K3XsPZY69p6ROvYYpVhDSrH+ytQxQd5BqdkQQgENcQH2KkobM5BSvlKvzD7nZiTyKtGbyyK7O8tZ5IXW7CNX0zJZsnOdSDVjF7k3zJ3QXFPOxQQeDn3Da0lkt6RVciIoJ6XTBqmcSGfHRBDgmmmrP8xBlbeZ2TnwsItUcVokdIwATiHV1HvV0DEJdRJDSv8AwfVBR3DUf2KPM0jrm/rB7IwoPiKK2cHXWAiy+ar/u7XqlMCh8sct2LmX9T3HBXzPnCuUEeJr5t1XlYI2qXqTqjfhvgn330e4b1L1xnYb2/1n2u4zUvWQDd2fqmPCk1N1zG2vsyqX+uBOH/+/M3ZnKgEDp95Mxy5XT2Y5uMsroErh3if5ELqWuBt1wm3Nzq3/cJjcdfyliZa/NNGqLk204vJiqK8PPLrzp21vIUVI767NM9mGc6MjwlOlv7jjtgOwboVXokOo3gJpAl2lDAVI2/HdSFJt7wcdcC+FcNI7qk70PgiZbl+SeKcgknkwa3StIKiZGwaKGWqMH6yb3XZqtUQf6Lo06d230+IB3UPLKvY9uBvmM2C6QCKRULu0e04Jud996eruLMjQq4Du0mYnNK3L3gtuUC340zGvfvp08ZqNKA11bqCwlAELSXUDDOkUKuLcXL88KUKLXOQxuhj5W7r9ubM4ZFZsmIJg9lmdC8GuDgMTjuH/z+CwHUtpkXA+glZdv6rOeosbkVJoXDjnLRPVAYc6fG7daxcGXb1Qu5XT/qxabF8ar/P+1kkg0ZV/7Cor6eI1ul6KxL9KaC0PreWg2dcLWHjWXsX+bHcM2yYQPLWOWy/e3MNr1eBRcYURgrqIA3Ei4DF/gioupfZiPObgtQjePB6f1Sd38Wd+GfMujVmEyDRhhywea23Fvxkj1SEzuBoVsKIXo+VuG7WcRbS66zWUWn7LlmwhY3T4LV1QcAmL9r0TZ5K/OMnC5n9x97l+maPZDV8hsNLMRMf2xTjThi3asOV9gA34+7hFigXbJhqcH/AKsDeTv/MEAdGa3/OwVnp1B77j1lBoiIGqg2KzXf9ld+bgwifmHtDsag7cMCXc1ZkyujwUYFHwmmNW2SpY5OAyvqlGzFzgm8e3euFJcfTvRi9R3J91VE5UOv2zvfQ9nuTv43f/Io/XeJrv0dOEFJg6k2ez38A4KIuV2kVZX0DVb6k+6V7nimud4U7igzcpw5zV1xSfcvHvKff+vvFG2lpEVuqkFUqsum94H9Lc5cYode7HAn/x1Lk4V6SgBJz9REsdUJbynJyBc4bxWArXUskEz0kya2SQeuIcWLjtjMLZARoZzIG3s0jl+UCmgOea/uXO3PkZn4+TOdB3W4QjKDpcDW+zT6hyVQxtpgqXDj/j2a86lLrn4Pcp2QPbL20EuepkUij6VRigXUwYhyU+YkiJtHHh/T1qKSVKXmiXMVerSudHFkokuHujwkwsxO9lVLOXR/aCudjQqgfrSYrhh2hmhJyJNOj60t3JR2DDSFt0fZJqbAQr5K2itsPHw4sliACmwvshbUadsMh2aC6AUFXp1WezvdFeb7kqC+OZtvmEqxpwf8H/3pvge/VL94u6eTt7c/H9/hRRSBSowutk1LEkPha+4vS1/1UUan/M3i2rf+omPVz+w+eMIQ5af3tLTS+qh+9oGGRQR+XqelbquhYB1CV41+qe9j3SeHUWSHrtXtvVf+poJT1ln1ZNZy2aCB9/E9TZwbo78l++9eZQ8Q/Cu55WcHzlwqWXWFT/+xW+nffg3Otai+X0klR/EH5naeKbRYZ/wSD93Y0+4z/53ywEmVs/fhuVrVfM8WDL7HdV8hc+gOOY9l9cJJ70
sidebar_class_name: "put api-method"
info_path: docs/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update Native Change Detection Configuration' (put-native-change-detection-config)"
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Update Native Change Detection Configuration</h1>

<MethodEndpoint method={"put"} path={"/sources/{sourceId}/native-change-detection-config"}></MethodEndpoint>



Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body.
    
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"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"The source id","example":"2c9180835d191a86015d28455b4a2329"}}></ParamsItem></ul></div></details><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={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"A flag indicating if Native Change Detection is enabled for a source.","type":"boolean","example":true,"default":false}}></SchemaItem><SchemaItem collapsible={false} name={"operations"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`ACCOUNT_UPDATED`, `ACCOUNT_CREATED`, `ACCOUNT_DELETED`]"} schema={{"type":"array","description":"Operation types for which Native Change Detection is enabled for a source.","items":{"type":"string","enum":["ACCOUNT_UPDATED","ACCOUNT_CREATED","ACCOUNT_DELETED"]},"example":["ACCOUNT_UPDATED","ACCOUNT_DELETED"]}}></SchemaItem><SchemaItem collapsible={false} name={"allEntitlements"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"A flag indicating that all entitlements participate in Native Change Detection.","type":"boolean","example":false,"default":false}}></SchemaItem><SchemaItem collapsible={false} name={"allNonEntitlementAttributes"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"A flag indicating that all non-entitlement account attributes participate in Native Change Detection.","type":"boolean","example":false,"default":false}}></SchemaItem><SchemaItem collapsible={false} name={"selectedEntitlements"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"If allEntitlements flag is off this field lists entitlements that participate in Native Change Detection.","type":"array","items":{"type":"string"},"example":["memberOf","memberOfSharedMailbox"]}}></SchemaItem><SchemaItem collapsible={false} name={"selectedNonEntitlementAttributes"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"If allNonEntitlementAttributes flag is off this field lists non-entitlement account attributes that participate in Native Change Detection.","externalDocs":{"description":"Learn more about account attributes here.","url":"https://documentation.sailpoint.com/saas/help/accounts/schema.html"},"type":"array","items":{"type":"string"},"example":["lastName","phoneNumber","objectType","servicePrincipalName"]}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Updated native change detection configuration for a source

</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={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"A flag indicating if Native Change Detection is enabled for a source.","type":"boolean","example":true,"default":false}}></SchemaItem><SchemaItem collapsible={false} name={"operations"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`ACCOUNT_UPDATED`, `ACCOUNT_CREATED`, `ACCOUNT_DELETED`]"} schema={{"type":"array","description":"Operation types for which Native Change Detection is enabled for a source.","items":{"type":"string","enum":["ACCOUNT_UPDATED","ACCOUNT_CREATED","ACCOUNT_DELETED"]},"example":["ACCOUNT_UPDATED","ACCOUNT_DELETED"]}}></SchemaItem><SchemaItem collapsible={false} name={"allEntitlements"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"A flag indicating that all entitlements participate in Native Change Detection.","type":"boolean","example":false,"default":false}}></SchemaItem><SchemaItem collapsible={false} name={"allNonEntitlementAttributes"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"A flag indicating that all non-entitlement account attributes participate in Native Change Detection.","type":"boolean","example":false,"default":false}}></SchemaItem><SchemaItem collapsible={false} name={"selectedEntitlements"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"If allEntitlements flag is off this field lists entitlements that participate in Native Change Detection.","type":"array","items":{"type":"string"},"example":["memberOf","memberOfSharedMailbox"]}}></SchemaItem><SchemaItem collapsible={false} name={"selectedNonEntitlementAttributes"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"If allNonEntitlementAttributes flag is off this field lists non-entitlement account attributes that participate in Native Change Detection.","externalDocs":{"description":"Learn more about account attributes here.","url":"https://documentation.sailpoint.com/saas/help/accounts/schema.html"},"type":"array","items":{"type":"string"},"example":["lastName","phoneNumber","objectType","servicePrincipalName"]}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"enabled\": true,\n  \"operations\": [\n    \"ACCOUNT_UPDATED\",\n    \"ACCOUNT_DELETED\"\n  ],\n  \"allEntitlements\": false,\n  \"allNonEntitlementAttributes\": false,\n  \"selectedEntitlements\": [\n    \"memberOf\",\n    \"memberOfSharedMailbox\"\n  ],\n  \"selectedNonEntitlementAttributes\": [\n    \"lastName\",\n    \"phoneNumber\",\n    \"objectType\",\n    \"servicePrincipalName\"\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>