developer.sailpoint.com/docs/api/v3/get-access-request-config.api.mdx

---
id: get-access-request-config
sidebar_label: Get Access Request Configuration
hide_title: true
hide_table_of_contents: true
api: eJztW21z27gR/isY9sMlGVG25Hd/aWVHufNNHKeO3UzHzsxBJCghIQEWIG2rHv/37i5AipRkW8ml7V1GX+KIXCz29dldCLoPdC4ML6RWJ3FwGIxFMYgiYe25+FcpbHGsVSLHQSewIiqNLKbB4dV9cGmFgTeFuCsGZTGBZ4GM1SGnlaFxS8OI1h4awePg08OnTlDwsUVatwPzW9gAXsXCRkbmKAdIcTGRlgkV51qqghlRlEZZVkwEAyGMgGftrZjbqnSKdEFcI2yulRWw333Q39zEP+092kKw4yYH9loUXKYWOUWopyqQAc/zVEZEsfHZIpf7wEYTkXH8XzHNBfDVo88iKmBhbtC0hXQywFqjb3hqT0tbHInhXSGM4mlj4UjrVHAVzBvjJGGFKUUH9Ves5sMyYMRGgsFn1ETEbDRlwvNldmoLkaEC4o5neQo7IJeHTsDLQg88l6Hio1TEq0vBuIqZt7ow/tONFLf4wQjykeVZLS3slYHBIp6mUy+7I6r0WCah53+mjsSEp8lZ4qNwwYeV884Uc6TsLGl7Etk/45g01bfn8zsO1FQrcTR1f1ezDydaFnFVWciHKUu08W+XOmSpBEOg0VMBMpxyxcfCrCgEyxz5Y3JAam1M4HUsDZgDKHJtCrsoFwhWyAI/BguyeX+g7N6N5yKTKhZmoOKhBW+T8R9zWxV9rFpFcTRb97UujPnUXqpCpjMWDWMBhAg037yx3pXZCLbWCcP1rNDslkvMKLCSi9FEGosWckJ2GZhX6fqzpYCvkEfEPuQLxC7p0Eo9uYWopUUV4RFkipN3q990x2YnUGWaYqbWMYP8jkRxK4SqjGh/j87EqVYN1Cxk4qHOfr10Gb/7GqlO+Z3MyqxhrqWCoLgWqgL+RevWwOPtWcXic4YF1rhdcNhrqNFbokYCmTni0RcXr8Kci2QZ0LfXzQeno65X2cJINV4wwQXogxSUtVoBWAKyn7wevrs4ufhnl134oMJaGuLrpgeCig4TUsbPb3YSQ0GDWs5k3Mr7YKe3u7/Z24m3+sn+wWbEezv7vX500Nvf3N/aifsCN1CA7s9v8UsJMBSiuGgZABubp3zKcDH6V3oJntNskEqos+yNMOPSatweiq1Mn99/iGSMx7FB3PuKHTnt2E3cjn+rllkNDyOdBU1crOwIcSGgK4nER1lM3oGKiIIkZ5N6sAJUooKKFmTwt92DLcDocEa5vI1ZsfgNF3ZcodS8SfnY1TVkAS5gDcGruvNEcT/WGVJSnwmVaJUWpN7S0BrcM/Jc2O1EQpjZcpTJosA3kEaPCBSLhJcp6AjpbUVDQPqM2CqUFPF/RUAj0A2/U76x4bWnqqD6gG1oE3AeS4y69lq3guQljo/50CUM4hJAkshyxA0qhDXewmslRCzi7rU6BdFljr7w/Ks2FS3BQytyDsEJpAwhD1bLuCbFenrdTICzWyXMddCBp1aXJhKNB77NuQ6oebgObrX5Mja6zA/vZfxwHTRlqd9Z9mKMSK44ZCtzj15WupWWNGi6oLntEqSfwca80B3WWNmperLOTJJDj6vbu7ubyfZOvLvZ293t7cWcH/R7mzv72y3sWEzRCjCaALNkcHt4QIrtZQPQcSrRzUNjIAJCQBCcsmCKAOe66uoQZaTjKXpYKnLWdxyJYhqyjnW8Qj15I5UIIUwlSihI5AgW4vBzI2MM3QxbAMcS8R5VILp2hQNLdHvsiMdNxCRl0JAGij3wOlmhhl4qCetZtQTqC2XSI9uKPcFHu5sH/e1kd5vz/v52b29ndJDwra3Ng52DA9wdMsBCkDRzmBvDpwtb/ywgpmTEUg3VQ/5b4AjGsUyiALQ5LJEw/dnnfUA8VuxPHG2tppeX4SlAB+aOo+P3bHuPpVyNS3rOx3NGUOHlh4UsAs0d4zMjx1ItE0Uo7NaugtfDN4PLtxfw5Hz498vhB/gf8lo4PhgoiNYYw1JTNznRtySxV+CWW+gjUzAHwtArz/UVKMT9KYMn9F28G6WZBwVY4XdfsqLJmiVGZ61UityRCXshu6LbAciBZ9CaRhM24ji/Y4sL5K8wkfMifOst+YpNoFUR5mWXDeJYopIAupCNJcIrp1YROh1MXccgKSGVQRjoRnRZUA8dtSfPhinnMa1Ck7dNp2BygOQrlJeoKEE4UrOZhXW0eBG9f0BmZ7m2dBcNo5FJp6rgUXWMEGlDo+sIdJNQWj0cobssAI+q6GrEaiEpSnPqhHldaHoX8dKukHfvU4CfkFSrX9wIn3w0TDk0Im9UbvKI5EcWWuypandViQ/zpkjjde6uc3eduyvm7vzLc3/s699S69NbbH0uFS/BvoaK50LrYyh6sMH1RO70wTmyw8AgvkX69eMFJPYXoZBe3OU4JnzH/siV8sXTs9of7vkI24/aWS1foIBkR6dBAkgk4kOSeyYxGcqZamtxtzfajCQEqFrSIgJqGjbVJTXuplSKBhvbYbEWVv1UsAkHfPRnj4SA7lg/pHP9dSe57iTX1WhdjX6carTuJNe5u87dP2fuPtlJ1lJRtvg+yZZZxs3URZp/j9pyBgSsuoDA6pQjV813K8iM1T1W0O4cglG/N+ole5HYjvl2vLt1kPSj3T7f2evt9Ubb/b2gWeuvZnlcJ1k7pxr+dn4kE0MTdwN9XEnf1hVax+3jvxJPghOENYSeum8Gm4NJP9W9Y/9gsXe80JqdcjWtb3q0ekg1sxFiGtBmSGsqWiDgbAy4qBhAlQS5MJRkJoALHiGzVGayPkkGvmYaDhK8leASpQqyeheporQECQkJUo1d89x3vmZKHewY0Pk7dqfeRb+rk2fnqPFb1JgN7yI6bWd1576z7Hz3RPmrIB+cgx856HXTDlcQADAQOMyq+851f77uz9c1fl3jf4wav+7P17m7zt0/Z+5+RX/uu6HH+3MgWLk/B9ruJqt7qTd0L+B/3aZTqngJKLyZjugmdDzrwamvgFDyt7gRQzhezQ42ll7LDvBKN/aFTqTSpEA6KYrcHm5s3IOnwEMPXZ7LbnUFSulbvAG1cbO1BHdmdx4BueIyovPmwfsTP110yb5GYgg7vKMNnLXruxZgdToZfpJ/dYVsqktAOGLTwatzPpzoMYiZwyzxkyXqLoXPgo6g26VJH57T5x9bT+nhmDyixzLzPbkX0DOQck49FP/T7AZ+46rPwj38WSHBQa2/sNkZkvXZkeAGJgL33cWLXz9evGRjbDUp1UtLN4EkzgaQLO8hRAjKBtU5Pi6i6mJ0OZ6Q4IPWNyWYOixJQWF2rT4Iwa6qm3LvAOPPAZTJpLhIEA7gqk8vKs/E4kakWP66M0ti4MlYbYCFNnhr3UsqdTQTSOXueuLVt2sVstd0xRmvsLpbTk5FGvHYVV7pxRt6fasQf6m4hT7ZiJt9OSeFM+1V5G7eRJC/yAIv86O1vnlzxy9s8AvpRleIXOdlQEt4Odrfb0WV175Zjha/EPm15bhWHycS6mh7GXOwxSyUwTRmJyyaaG3FXxnD0ME0uBqXkEXfLNYtbhpSRoT9zYZIodsylCF0hSTfW0gM5YKJj7AqU1OioV9TsUvJ38izkPO/0b2z31o60+MrKJ5IGevIfrPMuGGIG4YOA6yX39UmDCzIbdSBcMAFwPHM/4QEXtAG5jleS1Gd2G/QGiwNEYhKXGx+6D4czgDO/4/RC6SuaQCCsamuv/GDz8zzenA/PZkZqzoOmLfgoryphro4Zzcnb30chbXyj6YvajyYnZqcqXT6vVH6EST54+Du/wnx1kjzIyKNb3Mx3GjbuWv4GOSuW1s8w7P0ix74F95SplI/DdMKzV/UwzTZ5CkvMKYpp6OJFDT954IX2Pl1qt+1QR5Wv76zjtHYAA0kLV3sH8mUfnHwEcYrFYGJcbTC+xLA9bP2M9YHsPJ7+p3j68pxDO+elwp/oQFClBnjEB7PeDeWNiodCEGDr0SlmaY2rl5VZSSGDZqCfiIgTGbPEjwmhgm04cRn9gIfWn9GDIZEj7jfhgQzRc6F+3kD0rXb7+d4Q+SEE5HmONwBgkIzJRo7nJ5cLHAEZspduu5qM97wi+wG0gITHHVcMGx1YaTDR7m2BUyiDb4/i4I99cPQ+cC6n52Qf4cfrfqqgO38Ro5HUChk6cYLN8xdBcuHORgPJhp/t3EV3N/jMQVONg/4GMhwBr76NBtc8BMwdscVNP19ETQm04HGbBJePPLHMaQeMn8eog/4IxXN/we3enj4D7GwSb8=
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 Access Request Configuration' (get-access-request-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"}>Get Access Request Configuration</h1>

<MethodEndpoint method={"get"} path={"/access-request-config"}></MethodEndpoint>



This endpoint returns the current access-request configuration.

## Request

<div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Access Request Configuration Details.

</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={"approvalsMustBeExternal"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If true, then approvals must be processed by external system.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"autoApprovalEnabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If true and requester and reviewer are the same, then automatically approve the approval.","example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>requestOnBehalfOfConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Request On Behalf Of Configuration.

</div><SchemaItem collapsible={false} name={"allowRequestOnBehalfOfAnyoneByAnyone"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If anyone can request access for anyone.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"allowRequestOnBehalfOfEmployeeByManager"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If a manager can request access for his/her direct reports.","example":true}}></SchemaItem></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"}>approvalReminderAndEscalationConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Approval Reminder and Escalation Configuration.

</div><SchemaItem collapsible={false} name={"daysUntilEscalation"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation.","format":"int32","example":0,"nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"daysBetweenReminders"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of days to wait between reminder notifications.","format":"int32","example":0,"nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"maxReminders"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"integer","description":"Maximum number of reminder notification to send to the reviewer before approval escalation.","format":"int32","minimum":1,"example":1,"nullable":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>fallbackApproverRef</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}></SchemaItem></div></details></SchemaItem></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"}>entitlementRequestConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Entitlement Request Configuration.

</div><SchemaItem collapsible={false} name={"allowEntitlementRequest"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag for allowing entitlement request.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"requestCommentsRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag for requiring comments while submitting an entitlement request.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"deniedCommentsRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag for requiring comments while rejecting an entitlement request.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"grantRequestApprovalSchemes"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Approval schemes for granting entitlement request. This can be empty if no approval is needed.\nMultiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"workgroup:{id}\".\nMultiple workgroups (governance groups) can be used.\n","default":"sourceOwner","nullable":true,"example":"entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"approvalsMustBeExternal\": true,\n  \"autoApprovalEnabled\": true,\n  \"requestOnBehalfOfConfig\": {\n    \"allowRequestOnBehalfOfAnyoneByAnyone\": true,\n    \"allowRequestOnBehalfOfEmployeeByManager\": true\n  },\n  \"approvalReminderAndEscalationConfig\": {\n    \"daysUntilEscalation\": 0,\n    \"daysBetweenReminders\": 0,\n    \"maxReminders\": 1,\n    \"fallbackApproverRef\": {\n      \"type\": \"IDENTITY\",\n      \"id\": \"5168015d32f890ca15812c9180835d2e\",\n      \"name\": \"Alison Ferguso\",\n      \"email\": \"alison.ferguso@identitysoon.com\"\n    }\n  },\n  \"entitlementRequestConfig\": {\n    \"allowEntitlementRequest\": true,\n    \"requestCommentsRequired\": false,\n    \"deniedCommentsRequired\": false,\n    \"grantRequestApprovalSchemes\": \"entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584\"\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>