LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/update-connector-rule.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

116 lines
48 KiB
Plaintext
Raw Blame History

---
id: update-connector-rule
sidebar_label: Update a Connector Rule
hide_title: true
hide_table_of_contents: true
api: eJztXP9T2zgW/1c0vh9oe0lIQoAm98NNgHaXDhSOwHTmKHOr2EqiXVv2WTaQZfK/33tP8rckEOgyt9uOpzM0lqWn910fyZIenIRPtTO4dg5DpYSbhDG7SH3BTrniUxEIlTg3DccT2o1llMhQOQPnKvJ4IjTjiol7qROppszNm8fY/E4mM5bMBAuVYFEc3kpPeEwqKovFf1OhEzYOvXmLfQ4TAcU8oXcTKXxPsy3pbTXYluKBgP+58thWMo/EFuOxYDII0oSPfdH6qoYsCX8TynR4dvHTf4ZHp8efGU+TWRjLZM6kpv5kDP0nIXO570NHUDo8P245DSeMRMxRsGMPREtJtFwXqAqoE/EYGElEjJp6cJArqCs9eCVRIRFPZs6ylo6PWDghmZZ0A1yYbqBJxpozSOJUNBydzH2krWUQUdfiPvJDD4om3NdYwZ2JgDuDBwf1gTWTGPTvLLAqp0YD573b6bfF3v77fc57wuvzfnvs9b3dnV5vt7szGTuLG9M1WOEAjIDkqsxfrrJNGjaMewz+cuAOqiToItCeR5EvXdLk9q8aiTyUmK1Sr+jXeNOF4QZogoHOJqRnK2E4/hUqV5R1jcoHGcCzwHyJFBo7gbIVvSxbBe1RWGbFHiUddjo7Xu+92x73O71JZ3/cc/fa+12v57njvjcRzmKxaDwp2GEsKoI9JQ65lK0CRg7T2AUvBLuvCGmc7zliYs2yoBXxvojxSMS30hUHYhLG4iwLA+vygVQnQk3BrwcdeOL3+VP3/WKpt03McFZ6LnO0pVmUxlGoq7xdYniSabwQ0gzmBvRv08lqZ0KlAerwIJW+d8ojKMrtMJxA1BpDrBQfCV+sKT4NPTmZl4uNhlapmPJVMqY8p/Pp6OCwxBs+5to+x9So4YcRBd/lRfB8LkJQySicJD9fnI5KRKovHiNXrVUmfDE8/Hgu4kBqLDhMdRIG8neiAW9Hw/NSXyMe/Ryb8SBLiFT0WK/0stzZKHVdofVHjsrRjzUrPJLMsOyQTzvsyhiFLoaOgu624vy5cOBVWk4VT9JYrE+C1k0nqXLJe/PqLXZElcfkoXlFqaI0gVFqmuLYqWnoCtMEC9/ICTzO325IBURhTXKj4sL9eRxz9C6ZiECXynOaKvV9HCSzoeU10kgmV0WbExnr5DPSe2liQJJrUsPaXgw4gJ4qDAGsUAkM80/lh2VFrPIAqpnCCB+AP7m51zzKyciOuIs1KRzMBuxQtWHWFisaF6jN9Jc206Iy8q6kg1Hx7ukIvgWgaDKfab4azFmNZ6neVi7QpFfNZp1WmxKZ6Wsjyct1NGIBOU2xr85p3IK/7O8sd5d/kAozdZWUAKU8gT7GaSKelYGWUUHAIxTK8IkwzLTUZc4eFuXen8BXi5tHqlXx5WJhHEJHodKG7W67vT73Z2C3CoRfCfZeWBYqiLdGkzWarNFkjSZrNFnDlBpNft9mqtHk94wmG5sZWFqOBFhIJF5tYfKFy5FF/5shlGLHozP2fq/dYVeXhyyRAQgNXbG7mVBmedys+XLNMqplbtrdTrO93+x2Lzu7g93+oLvzb2QgQJAi13OwwXwv4cjnkBDyvjbytXh0apBjcDMr6K2bCBz6EuKZfYhjwP9NdkGujd8yJivfMvBbg1S33Jde6yWzhGVHqzqPJxIu/SyJPG3Yj1KJJmQ1iRwKYhmD036BwbgIAOwwQzLzNarXqugRNNHqsAPuMRsQ7NAKg+ETc/c3oHX8DE+7UhLas6wJpG4GcOuxbsW+4OO9dr/bm+z1OO++73X2d8f9Cd/Zafd3+33yMcB+gB31GvBS7fonoUQMqd0PXbDI76AQcGTQPTFAnT+Fd6o2IBrP0D9mQ1M3F9PyyxJxnzQYZwDJWW8ffFhNUyrn0yUlqObVaCVgQHJD+CyWU7k212czl6MPH4dXJ5eIyz/86+rDCH4hrRVQO1TgrR66JbAKvjAL74hjKwBGmobZiAvB32LvLNV3IBBXulxRmic916BM8K0JT/0EWtje17Qok2aTOAwqoURxc48ItyVaDTbGMhil3Rkbcw0NQvMV8d0Q5gFR0jyxmnzHZoJ7In7bYkPPkygk9xlEIxCF9nMgxLhX+gw5SRF503ctAFRMhQAERNUWhSqX01eWT07KRsHgAM43+8nQTVJgjsQsR2HuLZZFax/g2Wiuyt1lSWmk0rlKYFYk8RvnHNQYx6BhBgMqkzB3sOkIzaUh8aisXp6xykMjpbtTw8xREtI7l6f6GXF37kP6aZJo+YtbYYNP48BsvwejNTIz2YwEL2mqhY2XvxpngW8+EdexW8duHbvPjN3llxnusW8J+nRWoc+VstsocPBcgT4xeY8Ks70WZr3HGrLBQCEWIn36cmk3aUB9cR8hZn5FfGSG8hXmh7k9TPmYZgWZsSq2QAZJj0aCCWQi4Q2I74JjUpRR1c5qbx/DeCzBQdUaiAhZM2bzMKW9K3GqcIWKcd2g9Ui1lbAZh/zIaVXLZEDsVXnNKJQqqZFkjSTr0agejX6c0ahGknXs1rH7fcbuk0gy54qixeIknQYBj+fG0+x7lJYzqMCyD/EsDzky1TJaQWIsx1hOFTk4425n3Jnsu6Ln8Z63t9OfdN29Lt/d7+x3xr3uvlMe66+LOM6DrBpTJXsbO5KKAcTdAo5LFTiXTsLQqy7/gXpjMcG0hqknx82gc1DpTYEde6vY8XOYgGxAGLBj/Mjy4tXFCdKHrok86o2WzhFmG9WZLdT0iRt82GzMrqFjDR3r4acefn6Y4aeGjnXs1rH7fcbui6BjbxN07L0AOvbwjBnEE0CsPxM6eoA7EJpNwCggg5uCehXCxghEgV929dGGfcLjqUhyoFdBkd3+mu1lYYiH9uYZWNKVlUhVqAvTG9QNsG6c1YUKnE0hRSoGWUsCukWvkoFATAr+w3wZSIpjFAjoxvMmbayzMVMc7bO9SOX6KXBIScEPzY6MOy7BnWjDHaCxOa2DTiFRv+Iap7XWH1oPZhco8QlKzD7cu0JgzOfrv7vrdgkcA/MxpouRsfUj2wXMmjlXMI0Q95FJXzkEraF6DdXr4b4e7n+M4b6G6nXs1rH7fcbuC6C6RUOPQ3Wo8GyoDnVbbZZjqY/oXP93xE6hYjkg92ahS1jdKzA4bpAWUIib0LGTK4D4h8aVhymea8IdwWqAO1abQX6TRjM/SDYwhc4Nbk0NBDglioZ7+hvmMomBs51XbiIZvf0gvYWD/SLANLKlsQ81Z0kS6cH29gOYHEy9aPFItrI98iq8a7lhsD0WdGHDcgrDHasmXLEC3olhZystMlIsMQ5M0iTixmSkFvR4MB1tUniScrZ1fw4TGWbINHDDvfVJKgYWI5iQbGmq3bKXKyzJB3Jdxf7ij8tiCD0iyzr1Pdkb1GfA6ZKIdt9x5iYjRO+m9xVnKUYk/G7QXensDKt12YHgMUwtzFaaN5++XL5lU8SslDNSjXBZSJxkQNSdg4tQThxm20qwEQ1TcZhOzd0sw8rGHYxBNvFBYPZVjYRg18dWCZ9hsLiA7E4qxUaCEgq2unmTWccTt8LHcbRVaBIdD+JgGzS0zSvt3tKYSZMLqeBnQKWtr6rJjiSmMoljP9axItJckV1HmVy8JNe3MvG3jFrTUGsSNf12iQuj2mvXbAR3IREgCe5r0tY3d27oNUv0cCYGJUh1mQfUhOWjut3Kzaz2zXxU6DWRXpWPr+rLTMKAXG3GTNZiGsZT32PHzJ2FoRb/ZAxdB8PgeppCFH0zW3fYaZMiotltl1hqmi6bsgnwkvg7gcBQxpn4GId3QjehWWihkPyFLAsx/wsdofulIjMVX8MojDW90NXfzDN22MQOmyYHaMu/GeTQsSC2UQbKA8YBDgv7UyawjJbynqG1NqsT+W1qg0ODC6wSFR0NzMOgSHD2F6MXWDuvA2kY0Xm+AQ2vSLK0cKSrKCtbV1jW4Cq/fggD7JLeDL/511EcdP9q8qLEw2L55Uz589fO0o9kkr9O3v2TMl6daX7ETGPxMi5jXhRXjn3Ij+TR6bjN59sa2bVrm+4aWAPUlk7/5+ctS8fSKwe37eno4qq34rTrumN7T5xQzbvKzo/elE/vvjr1lTOn+dFQOtdZHOvccERz6Swm0sV0QW5jJ4blJHVg8fbqci5+b5gJ+AtvKdfS1AomrsUNgWVCkc8TzEqUld2ZFLQQFAlO1/01MDOEAWXSKA4xfYNJidCUDinG4HIcpu7SB3r0qSLrma4NVGZigHGJzzq1G2dCSClcTUWLfYG5uXJBgzgvxy3b8O7X0E7QRxBZ5xiY7CgLVgDNQZAqvGcQ2E4DxiElbIhoT2o3NQOPneIZEUKC7nmrLAtjqkARWjRDjQN9NrHuXwrcDX1B3Gr7gQFUX/K8QpAL4VMQYb3qtGsTbcgWzZnw6foDGDUFnqcsejg9vlyhCMSU/aoVxtNt20hvY10gUvjsTgu8tknTPSiPQp3AvLlE3FztAvOC6uWVy274UHxa+bHurrTRjzPJ7QiXUVFNqZnZmmWEa2dpGQFaDczdiTNQJ1Z4eMClNpxYL7AYxMN1nOubYs5srqaRGn97+U2Uj6r4zYXl+S171h2Ya6XIlozVvFgtcuDnbwIXmUCCxQ3UMquAxJ95YT87NS/N1TdZw5Xvabi6YFqYlcUn65bXaM6v0J/H9tLMwKxbxfwOCvHvwPkK/xy8VtREE1Si8gcnWwWGOoZshq3XQUv7A8wA1f4HSH/pHQ==
sidebar_class_name: "put api-method"
info_path: docs/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a Connector Rule' (update-connector-rule)"
---
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 Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>Update a Connector Rule</h1>
<MethodEndpoint method={"put"} path={"/connector-rules/{id}"}></MethodEndpoint>
Updates an existing connector rule with the one provided in the request body. Note that the fields 'id', 'name', and 'type' are immutable.
A token with ORG_ADMIN authority is required to call this API.
## Request
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"id","in":"path","description":"ID of the connector rule to update","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"8c190e6787aa4ed9a90bd9d5344523fb"}}></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></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
The connector rule with updated data
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the ID of the rule to update","example":"8113d48c0b914f17b4c6072d4dcb9dfe"}}></SchemaItem><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></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
The updated connector rule
</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={"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></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\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}"} 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"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
Not Found - returned if the request URL refers to a resource or object that does not exist
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
Internal Server Error - Returned if there is an unexpected error.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><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>
Reference in New Issue View Git Blame Copy Permalink