---
id: create-non-employee-source
sidebar_label: Create Non-Employee Source
hide_title: true
hide_table_of_contents: true
api: eJztW2tz27gV/SsY9cNuMqasp23pS8exnR3teG3Xj/W0TqaBSEjChgRUgoyjevzfey4AUtTDttZN292tnJmMRAIX93nuvRDwUNNTkfJMajWIav1amAqeiTOtTpJprGdCXOk8DUVtp5bxsan172p4FxQv2akciXAWxoL9xBUfi0SorPZxpxYJE6ZySmRB9HoiDUvFP3JhMnYv45i5ZRhnCtREQc3YtersEkNlKjBHg3KoVSa+ZkyP2CcZqb4SJu07Ap/Al6f7TkezWv9haeUFZh15tzZelxwNMbXuKWFZqCFLc7FTswtDHlDl02ksQztt9xdDpB9qJpyIhNOnbDYVWEwPfxFhBkLTlJSaSWHoreKJqIwyWSrVuLasozOMIhHXKQSDxVeOhzT/UmRcxrXHJQIv0T+ef9toGWd3ViWCJfW9Eumqms/p8TNkn1eQjNaxP9JpwqH82s3N4HhFnEEEy8hsxmS0yHcr7DUPGgfd/Ua72W42G43mfqPTGDb2Ru1OR4S92uNj1dJ3tDocFrTs9IrnDyJ1Y0R66byEpE9KH7/V6edxqvPpy4q/ngg2OGYQh2X4OKfB7gsieMEz6+dcKlP4qcmHAY8SPFkQsNlqt3o9YgdOmeovIjWrBjmVxgZMOaRiBZ6mfIavMhOJedl9f0fW+TpwIrVJOWGoc5U5WHpWRW6gN8z/maaajWUyLsJ3HGotcruevAOKywoKPz46omaqlXGqaTUaqxY4shgePQUaG8Mvj+PzEXivfvr2llqXSpaNxhvtRnvvoBV0RYcHnc5oPxhGYSvYC8Ves9nqdnphkwzgpg/WcrG4qofhQcS4MTqUVmH3MpsAM5BUX4Txwo32DsJuqxfuNZr4FPK9Ua8Rwq/axM1mCcpzQoNfycsrM9dqJnrl+utS2uMzPn2KuAe3LznTr4HhV2OLe7uqKqHyhML2h/OfTy7PDs+OTv7+w+X5zQVeDY5Pzq4H13+luJ0roXy6HolGWI/JkU1VssQmYys1REc8f4h8xtmYpFJcQa0uHT6BQG7OcaaviX8ofX0EPomNC3bswocbzW7Ubo0O4Ma82T1oej9vd6OWeMqqBb1LMRKpAM+38B0E4eO/ky62Fv2NWjTREcn+PNJHwJAgkyuprl+7nQhldVb2LdywmONDQXgJaBvNXtA4CFrt6+ZBv9vqd3v15l7rb6Qa16x8U048yed46DT67W59f594eHx8LnlvAHJhrPPo5GtGvhFvkrhOxZiHM6p8cwOYpvLXYbJho1QnVqCfm+zwYlBntj/kGQgNc3SFtkMckrwJnDFy4zkb5VmeCkYw6psYogECjKvITVI6o4moHAy8GhUNpg2hqc/gkIUTrsboLs80C2MJx0GlPdF5HGGhGN6vXBoBxzy+5zMDSjRtikIGgxc13aO/l9RKzni0pDdXG3XWlkOWKXaSptBVgCYY4iqI4GO32q1S/Er1hceuAPlGjWpk8/ORjjaoBt5LJYJxin4FHArLcoiJjPKcjEhviU4p1xLJwlZ23KIioYl6k73jEfMVJDvywlDEpzwk023ibzdKYj4rpgBhypZrzbJiX/DhXqPX6oz2Opy3DjrN/e6wN+LtdqPXde1VIowBxFehvID4xaV/ECiZZchiHcIi/xTkUBy6twzYxTfPCpbGBvqnrtKNnXeWjl9GmyU7cPx3Rxessw/MUuPcPufjJSWo4OaKSv08jvmQHtG+ByR3hM9TOZZr67MiRR2fvD+8Ob3Gk8uTv9ycXOET0VrZ/zlU8NaI3FLbXYKJvrccewEIz4yIoQ4AGnvrqb6FQBzdcGWgdN/MzECZ8K0Rz+MMM/zqa2ZUSc9xpwilYmfpe1kX9R3EO6E7z8IJG3ICLe1w9+1hGIppFpx6Tb5lE8EBL2/q7DCKJAmJNIpoBFHMnxEE8Sii0HUEPHJRqarzjFBKLtemc1UuWmMOL6dVo1BwgPOX/eQwzHIwV2ygleFQeotn0dsHPDvNLXJ3vZR9zExlPIQUaLhmUGOaQsMM4M0kUNXDEZnLAHhUMa5ErGo2t3D3k2MG1YR9F/LcbBB3FzHgJ7CilS++CB98cAPt0chaozCTRyS8JLHtZD+qNFcR+AxZPo62sbuN3W3sbhi7yy8v/SaQf2tLn+Zq6XOjeA79pjZ5rpQ+qfUepVkxyG3fO0PuUNviS6Qfb68R2J9RLmO8+DqlPa1vWB+5VL7C/GFpD/d8SOVHaawFWxCDVo9OghGQSER9y/ecY6sop6r26mrvdTqUcFC1pkQEaqZspnPGobI0V4o44WaHRVoY9V3GJhz4iA4W/DoEpFVVFEy1dBXutpLcVpLbbLTNRn+MbLStJLexu43d32fsPltJllzZaPF1ksmThKcz52n+vd2xZxjAip8jWRly1lTL1QoRY2WNVVusHGrDVnPYHO2HohPxTrTX7o1a4V6Ld/eb+81hp7Vfq+b6u3kcl0G2GFMVezs7WhWjiPuCOi5XcC6TaR0tbv9BvakYEawR9JR1M3QOlX4sa8dWb7V2vNaazunMigrJLNSQaq4jwjSMTWhsWozFAM7GwEXFAFUSfJEryUSASkqneWKZSBu8JAXoprPgcJRBFBcohZOVq0gVxjk4tEgQa6qaNRxL0h7uiGo+ULAV7Bjo/A2rU2+if6uSZ5ck8SlJzE6+hkJQoJeVe3fd/u5AuV1gduUM/MRGr+t2uIIDoCFwmFXWndv6fFufb3P8Nsf/MXL8tj7fxu42dn+fsfsr6nNfDT1dn2PAxvU5xtYbrKyl3pNz/dfLdBsqngPr3kyHYZ7a7eaiBrd1BVyJGJpqY0GEZxN8262eVAv8qQi8doW/YylPY4ycZNnU9Hd3H2ApWOixzqeyXpzXUfq+Hupk90t7De7QAQEXY0CuKA/tfjOdlXCL1K1+U0ku7PDOLuC0bSUiZ4XW7c7ws/SVP7g+gxzMkdlhcHfvTvYx2Jyil/jO2NF16z4rMkK2mzR+fEmen9vPyeGIPCHHOvU9uxbGM3C5JJ4/92EETA5C1l50wvbIAdVhTla++1gdc0WFueNwZeQ82VAz11ph6JyGtdg7wVN0De73je9/vL1+w8ZUjlo4yA1VwkJS/4CAuoAbWbg7LPb6aZLNQKnOxxN3cmbh1xQKLzaKoRT2QV0Jwe6Kw1VnyAOXAG6rdpokLFbQrI/fF9aLxBcRU4qsz7VNzikjtQst7vKFeW9sOrR9g1TuCBSe1j+ogB1LQilJaZ3GeBFtG8jupoVcvCLXa5n4U0EtcNQCS828WeLCqfbOHRmic1dWLTw2VluvXtzRCyr0qMnCE6K6zANpwvOx+BtYWFjt1Xws0AuI3iIfH9TtRCLXLk5jDtqKA1QDFk60NuLPjJHrUKjcjXNE2qvZuqdFAxsRQatRYSlwSwYyQOVo+TtFYCjnTHxImdsWLho1nYpc2H6ylgUufLJHxT4tyGwf3yHB0shIh+bVPNOCAS0YOJwwnn+Xv8ix6MAfZPAn6sgBjub2t0jgGa3goqO1Fvkt+V07h9JHCFYtFTPtuy/9OQj6T8y+oNHlGMA0Fd7lr4L4zjwtezK2qqxiy2BZg6v8xhq5c0lvjt9yy4ry6W9NXpL4cL6zcq7i2bdG6SeQ5LeDu/8jxNsizR8RaXwpTDuUlTtCJ0XTUlyPLC6HvHz5o1a5hUhnzje4KfXEzb3iKt3CTbq7jal+XHNr4FfMpiPziEFrC99IVSPflbmrm5+0Oz8Rxh58tvBlGxG0ecVNGLosNCczjXlGgW6BLpxIYbdNpoJnVDLvULDpxIITNECIiObYEhrbA+YprMjR6MoY9OrsFn2pgsgp9aR00ARUf9G+Ob2C/S7Ic9lx4c2oKpMkV3TiH0zkCeOImRdcPpImzB0yo0VVopBM29q2nFXAFMUSqcJe2xNpYs5HtL+O1r3i2S+sBcc2fnMdiqw45VyQSxHb0KNxi33LS7QRTsFExFNyQ6QVVJhVt/9pcL1CEcSUv7+k0/Gun2R2aSyI+APwmNCuoxemR9RfwsUrdN3dOrZwaa28yr10/ar8UeE/e1Hb508asjulDT3iPHfNmuuM72prO2ME2oQaaLx/eKA9H2oTH+kxGKUNhbuP8y7Qdl6YYPd+bEB+FrTn4H9sCOx1lXJzYfVXFGpM3Qy3n/Ts2I+VHv/inHbWakN/Dz1x2xUpv8dD+r9f+4B/hF5T50gYZJ8/1IrNP4xxdOnvXxEqHMY=
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 'Create Non-Employee Source' (create-non-employee-source)"
---

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"}>Create Non-Employee Source</h1>

<MethodEndpoint method={"post"} path={"/non-employee-sources"}></MethodEndpoint>



This request will create a non-employee source. Requires role context of `idn:nesr:create`

## Request

<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 style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Non-Employee source creation request body.

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of non-employee source.","example":"Retail"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of non-employee source.","example":"Source description"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Owner of non-employee source.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Identity id.","example":"2c91808570313110017040b06f344ec9"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"managementWorkgroup"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID for the management workgroup that contains source sub-admins","example":"123299"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>approvers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

**Possible values:** `<= 3`

</div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of approvers.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Identity id.","example":"2c91808570313110017040b06f344ec9"}}></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"}>accountManagers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

**Possible values:** `<= 10`

</div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of account managers.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Identity id.","example":"2c91808570313110017040b06f344ec9"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Created non-employee 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={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>approvers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of approvers

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><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><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"}>accountManagers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of account managers

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><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><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></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={false} name={"cloudExternalId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present.","example":"99999"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n  \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n  \"name\": \"Retail\",\n  \"description\": \"Source description\",\n  \"approvers\": [\n    {\n      \"type\": \"IDENTITY\",\n      \"id\": \"5168015d32f890ca15812c9180835d2e\"\n    }\n  ],\n  \"accountManagers\": [\n    {\n      \"type\": \"IDENTITY\",\n      \"id\": \"5168015d32f890ca15812c9180835d2e\"\n    }\n  ],\n  \"modified\": \"2019-08-23T18:52:59.162Z\",\n  \"created\": \"2019-08-23T18:40:35.772Z\",\n  \"cloudExternalId\": \"99999\"\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>