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/list-workflow-library-triggers.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

87 lines
35 KiB
Plaintext
Raw Blame History

---
id: list-workflow-library-triggers
sidebar_label: List Workflow Library Triggers
hide_title: true
hide_table_of_contents: true
api: eJztW+tTGzkS/1dUsx92Q2EbDITDX+4IkD22yON4bO4KUrXyjGwrzEgTaQbwUfzv192S5mEb8LFbe5s9p1KFPSO1+t2/lqX7SOfC8EJqdZxEgyiVtvikzfUo1bcncmi4mZ4bOR4LY6P1qOBjGw0uozDCRp/Xo0TY2MgcSQCB84m0DKlYVkwEu/UjWeGpMH7DZcqHqWCFZlNdAllxVwijeHqoYyB/P0NxP0kkfuQpS3RcZkIVxC8bacMEjyeBNlAqTQozJkWR20Gv1xretbBurqUqurHOepZz25uINO8FFm31qWMLkdvupMjS7wLf0cN6lHPDM1Hgt8HlfSSRu6+lMFNYWcEb0l8mi2hWKe/4HVNlNhSG6REzwpYp6kfDx6I0qnulzoRglz9vsf2Px+ys4CrhJmEHOk1FTLJ+rJb+/EMlnrgRKZpvRjSZqB7PZc96Op24otOpRXhF+su0EUwq+Jg5LQHvRnwtpRHgDiOeWoH24Vmegnj9nY31yMYTkXG0UzHNUWZYVzj1OzLu0VYfHmRSyazMogHMy/id+0xUEjHioAX69vCwvlibejSyYl6dH+gxsA0aRCcblWnqtcrgRZdd2JKn6ZTZXMRyJEXCbmUxYWtknTVUfM7HUvECnHBidDmeEB1vmG/GHL/CGJX6H1f+SKaFC/s5DuZWtRAmaowx0rbUW6JReXxpYRSpOiiD2SnE5x1z04ZgKal+Z81/5wQFzjqez1dX6kq9DU8ZJDRb5rk2BbCHViKfA1L6Fl+Df6UJ5DWVMJdLtbEDpLC2JpO1tQFbE1/XoobZIpkw8ZVdwV81kAkkKFlMO7wAHQ7LQthOPOFqLJKrKHqA/GpFXBoYQTnnwgpzoMHGd8V+WUwwGdt8EBLXwAieRJ9xFoiSa2UFJdT+xsZ8Xj2BJI3paC5FA68xLqEKnMTzPJUxeWPvi8WZ9/P258ZwdB1ZiIxWBJFI1FAp2HmVo/0UPfwCpoDvuUG1FdKxKpN5t5qrMY4WOz7sMqo38J+jSxUyZui9Nucx2Or4sDKXl607Y4cn9Y/u7BiZVV1ggN4CRYVRdRkd/Xz0/hy+nx38/ejw4uToED4f/fP86PT9/glWynplN/IhxNqyAr/H0U06x557tl9xzw5q7ltUll3ksPG0udYHJViVosK6tdaY11oXF5b2cAqiyfhs1lOGWqeCq7nVDzEWIUMBoduJAJM5uyWODNNlkZeQ3Ykc2ttVTpcv8hTMja6MMzjF9/e2PQUdpabmyTiYoiAbeN+pXXEdXl6LxgMkz+tYweSKjIIuCILQ9wm3LJGjETxVhc8LtLAFICShRg2J4g1oLwm8UJ0acgtPILvV4IgIehJNM1AGRg0rEO4oPL2fi6q2dv3AEAZQ/qap5qA8EMrFN6yJqR8qKX0cFKYUzyGzkEFqbAc5EGwgDSP2vJ7tPDB7ImEDaLM9eK+KTqDbq9SCviVqoZ3LOTRWeSKskwhI7wVCP5RJ3P7M0xKfZ9xci8I5v06T8NjyVCDAaxPJuOIuY9UUXH6KhNh9vbe5u7W1uTfc3kw29+JYxK/j/tbOdn+rv/U6rqtoBs7eHZfTOvEdH0LsH5//C2WpmViO8u6wpqxkLB6jPCsLWEGmbV180RPVTbT42xjfofrbSqneT3RRjcDKEmL/OZ4F3+mP2iwHmgtZfnCQ5S35/ILaMuubM5iwmZ3Q+bD/4EUz+UNqiEVe2GY4XX5uFq0nKxM2C+cQEM9n0kMPZqxHCiGSMVfhk4vjVmLFzIQKQlw6ljf0t8CyFuPiI198WQzjuRwrSrCgCZE+z8k+m5TgxwxxAaUVWscVRVjgWdYO/Jqu8ixfr4JEPie7bFA7ZHMJ5SnXIHOJWqE0Vhw58mI4CRAEBCqLFwvJ85Gqjq4CbwLXtXYWZUZf8xGJoTvDHw5aho811yHqMPkhBWwA4QOhKMBYExFfD/Wdf5JzgHOI9lLnfBkgUXnuAEZSuhYdF9LjMaXqEIYfZXxNZMf6BnO1isWP0NLk1fPKRpVfh4gCZGmovboWUwr7j1wS/CPGKwI8uUGqyblbugVkSHwM3VnA5zcP3tYR/eD/rUfbi+DoQSqxah4ZA97ZYadVfR/53gzaEyg3Q51M0dRS3fBUJt0XgNVH4jsRBUh9oJMlHPwtAJXO2HCJHApiOYaJvrpjV0CJyJEM/kTj2ggUNNHdZG+gEp96+Q68MKhSw+NroHW8BCS+UBLmszAFAFoFfRcsK3YFH77e2Otvj15vc97/y/bm7s5wb8S3tjb2dvb2cHVA0ZaPxaJM3F76R6GgT4pZqgHMyH+DQiAObNifwcWjpXMs0VgywbixlZieX4YeuQ6Z4M3BR7a9y1JACCU95+MZJajOxdlcZGNuJcIfoGjIhbA5hP7h0dv9ixME/KdH/7g4OoNPSGtuS2xfgbcm6Jaa9n8m2GvVAtwCanRRD+CZrXmqawyRg20OlO6bnVpQJvMdPMzwqy+Y0STNRkZnrVCKXR/JfpBd0V0HcArPMl4Amq3wKA5f26ey2TnxmlxjE6gmwrzqssbW3A3mDwvzp4hyeZKIqqaMSghlQVswgMkBbxeIXFq2qFU5m2dDXjlpGuXBJdwl6l9clMAcidmMwspbPIvePsCz01ybu/OG0kiluGcBbYYD77E2BjTMoNgwCbDDpyPaNoDEo8K4KmM10yWlu3eOmcNC07uYl3aJuPuYQvrpkGjVixvhg492F32vgdaodlBdRvIbZzS56ki8LkLgV6VvFbur2F3F7jKxO/vy1G/C+bcEfTbnoc+F4iXo11DxnIM+hrxHaRYGuXbAGXIdmx4PkX76dA6BfS0Ujhd3OeLg3xAfuVI+//NMZQ+/hxu2eEPpr22BDJIe/e83kIlEMiC+a46jGiVuza8GeHIowUHVAogIWdPgL0oMgDgzpVLICbfrDDpOq74v2ITfCGoCra16LKGSjtuAWCHJFZJcVaNVNfrTVKMVklzF7ip2v83YfRJJVlxRtHicZMss42bqPM2/dz9awQAWfg5mVcjdhN8dmmgFibEKY0Vt5BAN+5vDzdFuLLYTvp283tob9ePXfb6zu7m7Odzu70bNWn9Zx3EVZO2Yatjb2ZFUDCDuBnBcqcC5bKF10t7+A/UaMcK0hqmnws2gc1Dp5wo79vcW7O9qzd5xNQ0IybYwpKp1hDkNxmY41oSxMIDT9rxikKok8IWuJDMBVAyeJKHDJRi8KAXQNdPO/ghPP7hACU5WrSJVnJbAIWWCVCNq1uBYEoQUI8R8QIEQ7Biy82+ITr2JfhWSZ6co8QlKzI7uYiEw0CvkvrNof/dYuZ8S2Zkz8CMbva7b4QocABoCl7Mq3LnC5yt8vqrxqxr/56jxK3y+it1V7H6bsftf4HOPhh7H5zBgaXwOY7sbrMJSb+kQ7+8N0ylUPAfk3kzHcWlouzlgcMIV4ErI0JgOGdABh0FUn7JP3RGBXuPcqQP/jq32kbF7sBZY6aHLc9kNZx+UvqVzY0NQ0YLs406GoufgADpS7Bbokn6NRBd2+Y6IO237g9FRdTTtScrhmMtUl5DhiMw6niLx7kSPgcUceonvLY3ukvvMyQdyXZj04dfL4gg9Issi9T25GoxnwOmMiChC42gynfJ0q88dUK6LCTZr/bnFPuCwPnsjuMEzn/T7xQ8/fTp/xcYINync3blxIelYKGcfwUUone2HvXycRBWmPsy/3/q1BMOHodd1mT/dH47Ovoc8fwqJmVSKkwTlApy1/Alz3pr3yFn+K9Vhh9K4A+h0+CqISG0eu8yDXLwh10uZ+C5Q6zhqHaKGZ9tbXDjVXsbu9E0MMYwkeGpJWy9e3NHrNOhhEwVPkOosD6gJz0f7N644WO3FfLTodZBem48r9WkioZa2pzGXupiFUpgm7JjFE62t+Ctj6DoYBpfjEqLoxWzd4qIdiohOf6PBUsct2ZEdQIbE3wkEhnLOxIdYmQmYaMBsKnEh+QtZFmL+FzqA+0tLZnp8CQUUR+LZ2hfzjAt2cMGOywHW8+/qEzoWxLa7FYZHc8kBDmr7UybwjDbynqO1MKsT+R7NwdIQA6tExeYD92VQJzj/idELHF2NgTSMwLr61Q++M08Li1RLWWFLYFaD8/ymGmrjjN4cv9WWFB3W+4PJixLv1zsnH1Q6/a2z9COZ5I+Td/9HGW+Vaf6MmcZDXXS35rWnppO/8XhtficPt5rpcgi8pVglVA09i7uuiCimSShPeUFnkjGq44kUtAeQC14g9ltHz9IZRSK06xj+eJcGCY0NjIGwtYBJ+VCmQC9cS6GVOQWMA5ZoV/xuS2pEcC13y6LLPkFbpmIwC7ZkeM4C3n3Rvjc7wxPDaFh2GIwNoCvLSoXXhIDtMmMcXOoZj0ikjUuXuKBDUyLoQhP0q2aFKEZXQxG61JyYzH4Y4fYydK7R87dN/Fpg93DlDVSPVvS3FWpBTkVKnrn8TZZAG7ytgxcH6Mw+sAUtXmOFd8fncxSBmLIgFzTf2ox7fpLt4Vgggu2Rc5+t7mZ3o0PtAt5N1raANrZBnG7nVPfv/HnscA/Pznrjfb25/qI73L58IO7v5bhfhUyVrg9xnd9lNNv5UePq2YFuYgIi4LD7e9zZwGboAR+7a6nYEYJScdH6HuqjEnxbF64X6u5a4F5BuE/udwMiuqW0vB7+v25KP6HH6ib5CxW5ushcX2R+Qs31nfFaz5/r/Qm8bwVj3c4khbSb5vYuG7Pmft1DKtV+0o9HmDb5I8DVf8ClHh7+Ayg8fN4=
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 Workflow Library Triggers' (list-workflow-library-triggers)"
---
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"}>List Workflow Library Triggers</h1>
<MethodEndpoint method={"get"} path={"/workflow-library/triggers"}></MethodEndpoint>
This lists the workflow triggers available to you
## Request
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq*","example":"id eq \"idn:identity-attributes-changed\""}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
List of workflow triggers
</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={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Trigger ID. This is a static namespaced ID for the trigger.","example":"idn:identity-attributes-changed"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={""} qualifierMessage={"**Possible values:** [`EVENT`, `SCHEDULED`, `EXTERNAL`]"} schema={{"description":"Trigger type","enum":["EVENT","SCHEDULED","EXTERNAL"],"example":"EVENT"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Trigger Name","example":"Identity Attributes Changed"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Trigger Description","example":"One or more identity attributes changed."}}></SchemaItem><SchemaItem collapsible={false} name={"isDynamicSchema"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"inputExample"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Example trigger payload if applicable","nullable":true,"externalDocs":{"description":"List of triggers and their input schemas","url":"https://developer.sailpoint.com/idn/docs/event-triggers/available"},"example":{"changes":[{"attribute":"department","newValue":"marketing","oldValue":"sales"},{"attribute":"manager","newValue":{"id":"ee769173319b41d19ccec6c235423236c","name":"mean.guy","type":"IDENTITY"},"oldValue":{"id":"ee769173319b41d19ccec6c235423237b","name":"nice.guy","type":"IDENTITY"}},{"attribute":"email","newValue":"john.doe@gmail.com","oldValue":"john.doe@hotmail.com"}],"identity":{"id":"ee769173319b41d19ccec6cea52f237b","name":"john.doe","type":"IDENTITY"}}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>formFields</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"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
One or more inputs that the trigger accepts
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"helpText"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Describes the form field in the UI","example":"The name to give to this certification campaign."}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A human readable name for this form field in the UI","example":"Campaign Name"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the input attribute","example":"name"}}></SchemaItem><SchemaItem collapsible={false} name={"required"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Denotes if this field is a required attribute","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={""} qualifierMessage={"**Possible values:** [`text`, `textarea`, `boolean`, `email`, `url`, `number`, `json`, `checkbox`, `jsonpath`, `select`, `multiType`, `duration`, `toggle`, `identityPicker`, `governanceGroupPicker`, `string`, `object`, `array`, `secret`, `keyValuePairs`, `emailPicker`, `advancedToggle`]"} schema={{"description":"The type of the form field","nullable":true,"enum":["text","textarea","boolean","email","url","number","json","checkbox","jsonpath","select","multiType","duration","toggle","identityPicker","governanceGroupPicker","string","object","array","secret","keyValuePairs","emailPicker","advancedToggle"],"example":"text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></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 \"id\": \"idn:identity-attributes-changed\",\n \"type\": \"EVENT\",\n \"name\": \"Identity Attributes Changed\",\n \"description\": \"One or more identity attributes changed.\",\n \"isDynamicSchema\": false,\n \"inputExample\": {\n \"changes\": [\n {\n \"attribute\": \"department\",\n \"newValue\": \"marketing\",\n \"oldValue\": \"sales\"\n },\n {\n \"attribute\": \"manager\",\n \"newValue\": {\n \"id\": \"ee769173319b41d19ccec6c235423236c\",\n \"name\": \"mean.guy\",\n \"type\": \"IDENTITY\"\n },\n \"oldValue\": {\n \"id\": \"ee769173319b41d19ccec6c235423237b\",\n \"name\": \"nice.guy\",\n \"type\": \"IDENTITY\"\n }\n },\n {\n \"attribute\": \"email\",\n \"newValue\": \"john.doe@gmail.com\",\n \"oldValue\": \"john.doe@hotmail.com\"\n }\n ],\n \"identity\": {\n \"id\": \"ee769173319b41d19ccec6cea52f237b\",\n \"name\": \"john.doe\",\n \"type\": \"IDENTITY\"\n }\n },\n \"formFields\": []\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"}><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={"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