developer.sailpoint.com/docs/api/v3/reject-non-employee-request.api.mdx

---
id: reject-non-employee-request
sidebar_label: Reject a Non-Employee Request
hide_title: true
hide_table_of_contents: true
api: eJztW2tv2zgW/SuE9sO0ReRYfjtfFm7iFikySdZxJthNixlaom3OyJRXj7bewP99zyUpWbLdJNMp5gVjgI5CkZfnvu+lqQcnWoqYpzJS54Fz4sTiZ+Gnl5EaLpZhtBJiJP6biSR1jpxE+Fks05Vzcv/g3CYiPo1UKj6ngyydY+zD+sORk/JZgmcHBNycAruQU+Gv/FCw77niM7EQKnUwORCJH8sl7Y2dx3OZMKGCZSRVyj7JMGQGDOOK8eUyjj7ykMlULDCuMeFFwFSUyumKZcBTY+O5YAAZYwM9whYZpk0ES/HCrhKBpYYF4GrJY74QqYgTzZckKEsOjo4chRf4SwbONtYKe1VsMmAvbm/Pz15iEe0oYwG5pnEmIEF/LhbcOXlw0tWSSCdpLNXMWR854jMHPRoTXrPT7nQD0euKVlBv9EWnPmn6Tb/dDibtTuCQnC0vr6NgReS2N/JJMxAyXgFdKH2t4OOfE0L/sIsjmpCgSRoxmUMqRUJv/WixsGSqgLflcWomskhpSVckQkJe8M8XQs3ITlr1er3MrtUF2FqXBXZfbE5WJVM9t2KWhHhgNzoTvkwIynptyCTLSCWGiUa9Tv97tgKNLAj1s6XIw/Bqqs3ncXnCkvaIchrFC45dHDKbX2dqTlmSDd8TzV5v4nqi3XZbkzp3+aTtu71+d+o16i2v3ffJ1HLr35XKSEwFfMeHv0RGkUkS+ZKTz5wHEAV5/9ETTJq3u2wKlS1Ir2+vfhiOLgeXp8Mf346ubq/x6vxseDk+H/+bdL3hpxjdFomBMsV+TE41TmnBMYQQjpAAgYabwSjG4IxYVpyYm8VRtnT2mlXO5VkajQk/xLVfafsQ0f5VlbS9Tq/utYNmY9rr133utXtew+97vXqv2Q4aQhv9IzAKhdzJdI74TNrz/ShT6aWOTU/hGhUhrxCGXc90cCtjTTGxZt9uzISHNylPs+QxjQ6ur0dQKtnuaPhueDrWj9fDy7Pzy7d4urwa/zgaDs5Ik6ek+IsLzNhJAEOQQ5BewnsJq5pp1SrYv8jtvwj8uR8kBlyZjxKaXLKDKisl5q7iwDiC5Q0QJhjYhpYTgCkF+nWxnVfy32kYcS26Z8dNP4+b0yInVXg5z4eJ6iIKyOgfjyEBnNVNpdZtda+7uVDlPMg+8YSFHA854Vo1nNS9vlvvuY3m2OudtBsn7X7N6zT+oxmMBQWFb4nEknwMQ6t+0mzXul3CsN9vcj2dIzy+5gmJ7amYrHZLnSfz4m+O4znjcotf7nse8mPb7Xrtjut57brb87qe2540+g3RFPV6r+Wsi/RfMd1DOP7dw3GJdgGpJCaC6lj6nY7X6Uzak3rdw1PXbzbEtOnxTmdTZ96h5JV8wW4WoO6sv4DFGukFKgCas786KvuBrYla+8qg01BS+BnGMZTispFIs1hRtphW/HOCMpN0KRVoGpv9RhVmIFIuw9MoeEYyeyOVcGcxl4RQaMg+FjJiVQaULxZRLJghSSGVWNDzqk4GSdQ89poHzMqSnVpmSOIx938BrfNnmNmtkljP8iVU+iMGfGlb0RV80qn3G61pp8V5o9fyuu1Jf8qbzXq/3e/rEC+SBA1SOdvyOOarna3fCiVi6bMw8qGR/0EgCJ+QvQagNyf7g/aTp3WgaTxD/tRcmbkFmxYvozbwCF79+vSatbrIKmqW6XE+2xKCcm9vyOSzMOQTGqKGBZwbwlexnEn1WLg6G74Z3F6Mdanxr9vhDZ6I1k4xMVCw1oDMElBhC/Pok0ZsGaCMk4gQ4kDKYa8s1VdgiKukPFGav5JVQhV3IKY8C1OssLvvWVEmzaZxtKi4km96ZvZC1kTtCK0p5V+e+nM2Qb4K8g7q1cD3xTJ1L6wkX7G54Cg9XtbYIAgkMYmQCm8EUaxfUY/Lg4Bc1xCYZnBlgEEoibJUd8m+qOpiI8qqNjYR5aKsFHIOIH/aTgZ+mgGcZrPshYW1WIhWP8BsJFdFN96qD5KVSrkPLtBsrSBGNPk+IhN4k2nCbDgidSUIPCqfV0SscjTV4e57AwaZRb/zeZY8w++uQ4QfV7NWvPgorPMl1DaZaKS1kavJRiTbU+nFdlahrtzxGdJoGBx89+C7B999pu9uvxzZwx/7Vpc+3m7pc6t4BvnGOnnulD6xth4VsXySLm+sIo+ohLUl0ru7MRz7FzQ0dHr5eUmnV9+wPjKpfAf8oNCHGZ/k3XKe+je6IIBajoaDKSKRCE407g1iLSgjqububm+ieCJhoGpPiahPWVdRxjhEFmdKERKeHLEgEon6LmVzjvjI4RFJYiKgOeV19THvoZI8VJKHbHTIRn+fbHSoJA++e/Ddv6bvPlpJFqi0t9g6KckWCx6vjKXZ9/own2ECy3+GZIXLaVVtVytEjBU1llOtHJxJw5t4064vWgFvBZ1mf9rwOw3e7npdb9JqdJ1yrr/f+HHhZFWfKunb6FGLGEXcR9RxmYJxJWkUBdXjP4g3FlMKaxR6iroZModIPxS1Y6O/WzuOo4h+9V/lFVJSqSHVRkYU0zB3QXPjfC4mcDZDXFQMoUoCF5mSXAhQiWE0LJQLqZ2XuADdeOUOpilYMY6SG1mxi1R+mAGhjgRhRFVzBMOSdElgSjUfKOgKdobo/A2rU6ui31TJsxFxfEEcs+FnXwhy9KJyb+873z0H+JhixI1R8BcOek23wxUMAA2BiVlF3Xmozw/1+SHHH3L83yPHH+rzg+8efPev6bu/oj631dCX63NMeHZ9jrm1OitqqTdkXL97ma5dxSLQ5s0iX191DTY1uK4rYEoEaBnpS7v6KuuJc1y+RuXmt5+S4wcZrI/NNVuHbvhSlWgAZnGIdfM0XSYnx8cP0Bv0ta7xpazlNzlU9KnmR4vjj809UYiuCxiPw15B5uvT58H1ue01alrasSSDNtFPb2Bkr/kj04UO9Dnxo/Tp+gQpdRVliHeazBGD8Vvj0sOAuURn8V2iZ9e0Me3wCN5u43D9FD8/NB/jwxD5Ah/7xPfoXpjPgHKLPXvxI7+QfUMluNl951r2Jq1Q29bY2eyKpjXYa8Fj9Afml4wX7+7GL9mMCk/t+FlCNa+Q1CnAda5hIjqwDfJTfVqkc00cZbO5Bj6o/G5CjsSmIRhm79WNEOw+v1JziYg/QojWIqVFQkcFWvXhRa6ZQHwUISXD2kaSZHgyUMeQ0DGvrHupE5/uEKQyl7IwWnuvXHYmKR5JSuA0x7KoGz52v8z54iW+vhbEP3JqrqHmamrJyy0URrT3vrmH48ObiQQ8U0vrqzc39NwSPWqnMEJUtzGQJCyO6q9dfq61r8ZRoecSvSqO9+puLpFVq8uYCWIsQVIMA3bO/HkUJeKfjJHpkBvczzJ40VfD+kSbutoj3Ea9BMk1W7rSRY2o8V3AMZQxJj6hHK1LlAjVmwqMS/6kNQuf/0l/j/BThWc9fI9USjODyE++GjNt6NKGrokBicVvMhUZFl1BBA/m5r42gNON/nUksEBLMc/Q2hvVNfljvYZSgw+omkqyPDF/nGwCnH1i+gXNLuYgBFOJXfz+h7+ZpUXpqiKs/HBgW4K7eMMIWXJLbgZvcThFmfPPxi9xPNicoVypcPWto/QXIsmfJ+7+QRHvEGn+jpHGFr10FjnafBE13FzKLW7il74zQssN89QwbTdRdgpT3e2eACb6IzL8i7fas3U1jl5Hd2+65imTWYY8JR/QMcCfS6HPDpaCp1QpHpEdRgvtt4BFwQIdoiY00/fgYzDI0e3JEPRq7A7NmfKhEmrM6LYFqP4c2Q7tBlq51h/NneWKZvRBVqboCjRAZAvGYU5PWEMgEz8zQQt9mhI5Z5Eu+4pVuQeTmZEoarpFiRfJ1ZQOmdG/lpT+xF7QeWJPmCFIfRvfXIXeMDISobZKmlct15+iDUtz5yJcksIRcVF8idIO35+PdyiCmErAF1rwKJ4d20XJMc0FEWqNjDE0a2gIaYiaLPSxJboj+8kiq9z333xEWbGqh83h+h/1+aPNO9QwHC/pyIvYykwDY3rHe2d/74jFJ/p+vW0f0ZDMqefEgocHOiahXmpNw9iXevD7D5tWSbeY0BQ9o1udgp54RDgvRvbDwJfsmZ9e7uUrP/BTq02v7+DxF0FHBJI+rcQsc4ajEZoX9kcDV3+CsFm482sItZRmhTkXenTuh1Kvfn1FJ2TOxH7NuTDHDjH/RNLFvyfOe/yHP6Kl8QVM0uMPTn6IhzmGbl5V7Ssq7AN9q7te/x+2iOHH
sidebar_class_name: "post api-method"
info_path: docs/api/v3/identitynow-v-3-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Reject a Non-Employee Request' (reject-non-employee-request)"
---

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"}>Reject a Non-Employee Request</h1>

<MethodEndpoint method={"post"} path={"/non-employee-approvals/{id}/reject"}></MethodEndpoint>



This endpoint will reject an approval item request and notify user. The current user must be the requested approver.

## 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":"Non-Employee approval item id (UUID)","required":true,"schema":{"type":"string"},"example":"e136567de87e4d029e60b3c3c55db56d"}}></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={"comment"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 4000 characters`"} schema={{"type":"string","description":"Comment on the approval item.","maxLength":4000,"example":"approved"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Non-Employee approval item object.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Non-Employee approval item id","example":"2c1e388b-1e55-4b0a-ab5c-897f1204159c"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>approver</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Reference to the associated Identity

</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"NonEmployeeIdentityDtoType"} qualifierMessage={"**Possible values:** [`GOVERNANCE_GROUP`, `IDENTITY`]"} schema={{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group","title":"NonEmployeeIdentityDtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"accountName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Requested identity account name","example":"test.account"}}></SchemaItem><SchemaItem collapsible={false} name={"approvalStatus"} required={false} schemaName={"ApprovalStatus"} qualifierMessage={"**Possible values:** [`APPROVED`, `REJECTED`, `PENDING`, `NOT_READY`, `CANCELLED`]"} schema={{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status","example":"APPROVED","title":"ApprovalStatus"}}></SchemaItem><SchemaItem collapsible={false} name={"approvalOrder"} required={false} schemaName={"float"} qualifierMessage={undefined} schema={{"type":"number","description":"Approval order","example":1,"format":"float"}}></SchemaItem><SchemaItem collapsible={false} name={"comment"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"comment of approver","example":"I approve"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>nonEmployeeRequest</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Non-Employee request id.","example":"ac110005-7156-1150-8171-5b292e3e0084"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>requester</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"NonEmployeeIdentityDtoType"} qualifierMessage={"**Possible values:** [`GOVERNANCE_GROUP`, `IDENTITY`]"} schema={{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group","title":"NonEmployeeIdentityDtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"2c1e388b-1e55-4b0a-ab5c-897f1204159c\",\n  \"approver\": {\n    \"type\": \"IDENTITY\",\n    \"id\": \"5168015d32f890ca15812c9180835d2e\"\n  },\n  \"accountName\": \"test.account\",\n  \"approvalStatus\": \"APPROVED\",\n  \"approvalOrder\": 1,\n  \"comment\": \"I approve\",\n  \"modified\": \"2019-08-23T18:52:59.162Z\",\n  \"created\": \"2019-08-23T18:40:35.772Z\",\n  \"nonEmployeeRequest\": {\n    \"id\": \"ac110005-7156-1150-8171-5b292e3e0084\",\n    \"requester\": {\n      \"type\": \"IDENTITY\",\n      \"id\": \"2c9180866166b5b0016167c32ef31a66\",\n      \"name\": \"William Smith\"\n    }\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>