---
id: get-connector-rule-list
sidebar_label: List Connector Rules
hide_title: true
hide_table_of_contents: true
api: eJztW21T2zoW/iua7Ie+XGySQEthP+yk0PbSgcISmM4sZbaKrSRqbcmVbGguk/++5xzJjp0XoL2du72dfIFEPjo673qOIt+2cj6yrb3L1r5WSkS5NuysSAQ75oqPRCpU3rraaOlMGJ5LrQ7j1l5rJPKKGomPpM1bG61Y2MjIDMmA6EzkhVGW5WPBEiBgesiiag0D02z4QfVYrj8LxW5kPmYnZ2/+2zs4PnzHeJGPtZH5hEnLjPhSSCNiIGURTxJgCaO908MQFjXCZlpZATrctrrtNv5rCtJbtTzMhpEcVYRJPMsSGZGSm58szrxt2WgsUo6f8kkmgBc3hk9gnsxFaheXaljlzEsG5CD0yRCMfCf9vhE8h1lfCkHm9EvqwScgIU2dGdBZiqeiJNloWV2YSOzrWKCvMoPeyqUzCVHOFLC5kWq04Cx0ElKilfAz2geIxFeeZgnOey8GfWGuZSReiqE24qQMiDNHmUp1JNQoH7f2OvCNf62+dV9M51a7TxjOat/rEj2yLCtMpm1TtnMMB3zOYi0w4Hjempb2W1xMqCJFG74sZBIf8wyGKj/0hrkwzhELwwciEUuGj3Ush5P6sLPQIhc3vsjGjVd83h683K/Jhl8ra58afS0tfHCq4LNqCL6fCg0m6eth/vvZcb/GpPlgFbsmVZ3xWW//9akwqbQ4sF/YXKfyD+IBT/u909pafZ79blz5MD46aGjVqvSwvli/iCJh7WuOxrGrps0iktwwH5B3B+zVsgTAQMFwWwj+SjmIKitHikNlE4vZfz4L02GhIoreijxkB0Q8ELYez1JlRc64GRVYai3jKma6yHHwsRzC18mTe0oBcVjMezd8R+Wa56mKJOED1Dc3hfgxZaTUq2HNoTQ2f4f8vrUwIMslpWHpKviAVmoIJGOgg23lrvowb4hFGcA0I8PTFOIpqqJmpSR9x3g6XVLCwW0gDpH1yrlI6EJg7aaf2k3Txs67UA76s2d3Z/C1ML7yuemLyVxSPMj0nrhUNnICzBTthG0qZG6te1meL+NhCNyxD61jE8Jf9hurwuWfZMLSXDUjwCjPYY1BkYsHVaB5VJDyDJVyciIYdDNtXbLbaX31O/DVdON+ARplNka4SCziJdU2fphvDg9WIqwXnc5WvP0iag92O9vDzs5gO3re3unG23E02I2HZL9y/fshlGKH/RP24nm7wy7O91kuU1AalmI3Y0DbeYWYbrhlJde6NO1uJ2jvBN3ueefZ3rPdve7Wf1CAFEGKXC7BPe77FokSDgWhWuteuabTqxU+rzD4dEqBsb2sQdhPJCQ0e2UMdAYBc40LtBvSe8pFDBvomNoRqa55IuPwO9qHKtKa0ROLnMukrCJ3e/a1VCKAsiZRQkEiY3ZisbuWMSZGCmiHOZZlsBFd2DAkWCLssJc8Zj4j2L5XBvPH8Ogz8Dp8QKhdKAnzWTkFajcDvLVqWbEj+OB5e7e7PXy+zXn3xXZn59lgd8i3ttq7z3Z3KcgA/AF4tEvQS3PpN0IJA7U90dAWyj/AIBDJYHsSgBa/C/A0fUA8HmB/LIeOtlLTy8ty8TXfYJwBJmfbOxDEalTQOB/NGUEFF/2FjAHNHeMTI0dyabEvW5eDV697F0fnCMxf/fviVR8+Ia8FVNtTEK0xhiWICrEw1jeuH3cKYKpZaEciyP6QPfVcn4JCvGzcHaF03+zEgjEhtoa8SHKY4VdfMqPOmg2NThupRHnzFSFuKMINNsAx2KajMRtwCxO0IvKnPWgEsjw48pZ8ysaCx8I8CVkvjiUqyRMG2QhMYf4EGDEex5i6jsGwQOhNhwuAqJjSgARE0xczU87Xr7KgHNWdgskBkt8fJ70oL0A4UrOehVW0eBG9f0BmZ7mmdOc1o5FJJyqHtkjiMcgEzGgMWJjBjsokNA++HKG7LBQeVdJVFau+N1K5O3bCHOSankW8sA/Iu9MEyk9AqlUProVPPos7s6tG5I3STb4iwUPqtXCyp6rcVSY+gAmRxOvcXefuOncfmLvzD0vg458S9OksQp8L5U9acfNcgD6Gokfp8jjWHfh4R24wMIiHSG/fn/tzXKAXXzMEzT8QH7mtfMnBbukPNz6gtqB0VsMXKCDZ0WkwhEok4j2SeyaxA4lkqq3F1V5rM5AQoGoJRISqadhEF9BZIrJXeETFuN2gA0n1KGdjDvWR07GWq4C4qoqDTEuVr5HkGkmud6P1bvTr7EZrJLnO3XXu/j1z904kWUlF2eJxki3SlJuJizT/HLXlDAhY+QM9q1KOXDWPVpAZqzBWq4kcWoNuZ9AZ7kRiO+bb8fOt3WE3et7lz3Y6O53BdnenVd/rL2d5XCVZM6dq/nZ+JBMDiLsGHFcoCC6bax03j//AvEYMsaxh6alwM9gcTHpVYcfu7pJfBrXGCxWTEiHZBoZUMxthTQPaFGlNSQsEnI2gLioGpUqCXBhKMhXAxUDQsESmkpIXtQC+ZhLQb6I+Ucogq1aRKkoKkJAqQaLdYfoNl6Ak/VYKEGxCCHYE1fkHolPvoj+F5NkZanyEGrNXXyMhMNEr5P5s2fnuIQhvsEb0nYNXHPS6bocrCABoCFzNqnDnGp+v8fl6j1/v8b/GHr/G5+vcXefu3zN3vwGfezS0Gp8DwYPxOdCGbVZhqdcYXH85TKdU8RJQeDMdRYWh4+YSg+PdFgGDeH8IF7kAXL/vQrlX4JVUvMyh9vCyQZBWt5yD6nLwHlQ3Kkl3ErnB1hVePUgFRK6/GI0li+Mqrc2KOCivG7sOw+lemASIxnme2b3NzVsICQiFacgzGZbXn5S+CSOdbg7AD0tKHN5FcOmMBHgh2rcwITnRSMwTV1SJuXMpmQ0zAlxLx893ci5vZU10AWWU2GzgXSofszQMImbQsDyyRB1SjC7oB3pdmGT653VxjFbossx8d64G9AwknVPRXykpw6iP6N6tvhBMsx0LO8LuwmInSNZlLwU30Hq4H0kev31//oSNENNSTSkswmkhsQmBrDyFEKGa2St/MMBJtI0ZXYzGJHiv8ZMM5igbJqAw+6D6QrDLQ2+Ed7CZnEH1J5PiJEEFB2ddPS69E4trkeA+G84siYEHKbAJFtrkjXlPaE+l5kMq+JjSaPhBBexAYqmTiA2QxqtIvSS7zEq9eE2v7xXiHyW3wHELiJt9MieFM+1l5K74RFAokAVPLFnruxd3/IIaP+zUYAS5zsuAlvByNH9Ii0qvfbccDX4B8mvK8UG9H0vYsJvTmCtYzMJ+m8TskEVjra34F2MYOpgGl6MCsui7xbrBRQPKiKDbrokUuCUDGQD8JPmOIDGUCyY+wO2f0I8GYKhil5IfybOQ8x/pdvTHhs40fAm7NFLGOrLfLTMuGOCCgasB1svvNkEMLMht1IHqgAuA/Zn/qRJ4QWt1z/FaWtWJ/SbNwa0hAlGJi8323Je9WYHznxg9QOqKBsowovfqp0V8P8bzwp2wYazy3GHegovyJho24Dm7OXmrcy/clH82fVHj3ux45kQlkx9dpVdUkp+n7v6fKt660vyKlcbjaQw3WtY3HvUgf+nx2uJxIZ5njwX8haeUqwTdoTFyb/vRfegaoyzhOUY1ZXU0loIOGjLBc8R+GxhZOqVMzIzG9Id2khiN6P6yAZE5tIYyAX50FF6uzClhHLBEv+J3W1C3Q68UjqFxFSF7D72fisAt2PfhZQ549kn7BrAPnjlFx7KD0tkAutK0UPiSIohdpIxDSN0TEbG0UeEKl+8OnAqaoF81q8xiDDVUIaQOyKT2ZOhfaqo5/p61wO/lm45g+tlLIq2ZImciochEuiZsv483RFswFgm9GQVVV+BV69kKx4fnCxyBmXJvTYTajDb9JLuJtMCketOhtRV2wnZA7QKMZ9rm0HLVmONLp6z50qqdj8Hb2bn9X/U+qt9nsEHYzPD0DKUvXMPiGsPL1nxjCK3GGPTDR7e3eLaCndIUh78UAhv3y6tZE4TfgKU7Y6FO8rOg3p5OYWbt++LvFI1W9c0r9A1fsTv6D7jUdPo/RgUU9Q==
sidebar_class_name: "get api-method"
info_path: docs/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Connector Rules' (get-connector-rule-list)"
---

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"}>List Connector Rules</h1>

<MethodEndpoint method={"get"} path={"/connector-rules"}></MethodEndpoint>



Returns the list of connector rules.
A token with ORG_ADMIN authority is required to call this API.

## Request

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

A list of connector rules

</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"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `non-empty` and `<= 128 characters`"} schema={{"type":"string","description":"the name of the rule","example":"WebServiceBeforeOperationRule","minLength":1,"maxLength":128}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"a description of the rule's purpose","example":"This rule does that"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`BuildMap`, `ConnectorAfterCreate`, `ConnectorAfterDelete`, `ConnectorAfterModify`, `ConnectorBeforeCreate`, `ConnectorBeforeDelete`, `ConnectorBeforeModify`, `JDBCBuildMap`, `JDBCOperationProvisioning`, `JDBCProvision`, `PeopleSoftHRMSBuildMap`, `PeopleSoftHRMSOperationProvisioning`, `PeopleSoftHRMSProvision`, `RACFPermissionCustomization`, `SAPBuildMap`, `SapHrManagerRule`, `SapHrOperationProvisioning`, `SapHrProvision`, `SuccessFactorsOperationProvisioning`, `WebServiceAfterOperationRule`, `WebServiceBeforeOperationRule`]"} schema={{"type":"string","enum":["BuildMap","ConnectorAfterCreate","ConnectorAfterDelete","ConnectorAfterModify","ConnectorBeforeCreate","ConnectorBeforeDelete","ConnectorBeforeModify","JDBCBuildMap","JDBCOperationProvisioning","JDBCProvision","PeopleSoftHRMSBuildMap","PeopleSoftHRMSOperationProvisioning","PeopleSoftHRMSProvision","RACFPermissionCustomization","SAPBuildMap","SapHrManagerRule","SapHrOperationProvisioning","SapHrProvision","SuccessFactorsOperationProvisioning","WebServiceAfterOperationRule","WebServiceBeforeOperationRule"],"description":"the type of rule","example":"BuildMap"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The rule's function signature. Describes the rule's input arguments and output (if any)

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>input</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"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the argument","example":"firstName"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the description of the argument","example":"the first name of the identity"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}}></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"}>output</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={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the argument","example":"firstName"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the description of the argument","example":"the first name of the identity"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}}></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"}>sourceCode</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"}}>

SourceCode

</div><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the version of the code","example":"1.0"}}></SchemaItem><SchemaItem collapsible={false} name={"script"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The code","example":"return \"Mr. \" + firstName;"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"attributes"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","nullable":true,"description":"a map of string to objects","example":{}}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the ID of the rule","example":"8113d48c0b914f17b4c6072d4dcb9dfe"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"an ISO 8601 UTC timestamp when this rule was created","example":"021-07-22T15:59:23Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"an ISO 8601 UTC timestamp when this rule was last modified","example":"021-07-22T15:59:23Z"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n  {\n    \"name\": \"WebServiceBeforeOperationRule\",\n    \"description\": \"This rule does that\",\n    \"type\": \"BuildMap\",\n    \"signature\": {\n      \"input\": [\n        {\n          \"name\": \"firstName\",\n          \"description\": \"the first name of the identity\",\n          \"type\": \"String\"\n        }\n      ],\n      \"output\": {\n        \"name\": \"firstName\",\n        \"description\": \"the first name of the identity\",\n        \"type\": \"String\"\n      }\n    },\n    \"sourceCode\": {\n      \"version\": \"1.0\",\n      \"script\": \"return \\\"Mr. \\\" + firstName;\"\n    },\n    \"attributes\": {},\n    \"id\": \"8113d48c0b914f17b4c6072d4dcb9dfe\",\n    \"created\": \"021-07-22T15:59:23Z\",\n    \"modified\": \"021-07-22T15:59:23Z\"\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>