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

127 lines
46 KiB
Plaintext
Raw Blame History

---
id: update-workflow
sidebar_label: Update Workflow
hide_title: true
hide_table_of_contents: true
api: eJztXAtv28gR/isL9oA8YMqSLMuxgMOdYjs9H5LYteWmrc/ArcilxYQiWS6ZRDX83/vN7PIlKbHjyz16FYIkErk7OzuPb2b2oRsnSVUm8zCJj31n5BSpL3P1JsneBVHywdlycnmtndGlUz7SztWW4yvtZWFKvdDnVGVBks2FFEERRcKQEEmABx9sr44Qk5myr/zqsUimb5WXi1CLTOVFFuNdGIscTTOl0yTWqgMetPKKLMwX4OPGudAqO0jiXH3Mx0U+I950OiopjuYyltfKuboFm6nM5FzlKtPcM8YXsBv6IBkS46lE/+XZHPvEOrHQkEKm/l2EmYKE8qxQ4ChfRERLh/MUH7Yc9TGNEh+PAhlpauDN1Fw6oxsnX6TcMs/C+JpbSu4zcrze3lTJHenu7g18d7C747n7qjtwBzvD3WAa7MqgO3VuaSI0vNL588RfEMllbjwSR5zTK5mmUeixPrffaprQzSovRurgJc1I+3moNL018lnluC0f0iO1LKX0oZZSPbVzFfviaC7DyLndcpIPscqI8iql0AfjUC1IyVygoW4RtXbDBB5pAWbnodborslOjg9fiw8hTM4nJc/DGB2JjPRybtKkRDYmI3yAieUJUSKbBf0Toq1nYSo8GYupEt5MxtdoNV0Ye4UQmBIzQcNKcXoxEUkmTseTgx+EVU5nRZ5GjmssIC7mZLbHh0evJ8eTf5JH1aKrnq4TPJEiwVu/YaGx8wQqU7EHk4C4YeD30mIRh+AcUixVWdlFzU3f2+896z7bHT7zdvv73rDbwydPDoP9rtfb6e3QeA+zmzWDvYEuQzkX+J9M9/b2donIXWMc1t9oGDaGlhFIz0swWKhnUNGKwUL/imyWDCRvGueHWQLrkzlGnRa50qWNdBzmMAjjcInBanarQpjLlJjTuUq10WCLRTZo9RGQl6tVm9K5zPIvFzZ3I0OmUTufcFUxgRnTjJi1uydzAn+DF8yTTDFdq1I7KRJ0FmrY7AwW2nDo00hJPNZKtVBW+IlXzCFwBi9SQdnix/OT18KAmIDTCiW9mRmQ+KPZSN9nBcjotCEtA47VTG+aqERQ6VVRDwFE453L2id6laap4ZRhFzLFPAhFRE5y2nKCLJlTZ/RJkzDOv68+dTB5jhpemIaY0rHf+QYtv+mUFtXhIKQLI9iRk1vJx4hq55gZkS08T2nN4S9CqzOliwhtY8TYrVIz44PJ8clr1plt3jAN++SW/QijGh+z4j6srfaWIElOI9XEjWmSQE/xitKPuCXp3Q81f1zC6ypRIDyNk5whNVMc9wk84WNmMDJKY+LwIMlzs8GzUhl/J+az8PrahJC7/cs2NlbIhq+XA1UdQC8NwZbKr74UyI/+DsjG96N/TI7OXo9f4uP5wQ9Hhxcvjw7b4F62/AzXNMbtsgkmsToJOIkp9Xj0HpYkJrbXuG69dYeI6qYIGxGrBb4GtRxb23wNXzyanAtFIywJC2Z7dbvV4OIjAi/c7qsyokqipdrbPHC4aXFxDmzwCzKpr8cGA44hup4NL0vic2MJnGy2qVaotsoRgsYaf7Tt1r7jvM+4cZkWs1X0u931WdWbdn7tfEGKiByptLTPJov3STIqNo4PO6KGz4sLpBzXKqa6A+ItMCGDEOjVjk1+v9vzdtW+6+/sTd2BDAJXBr2BOxwOeoNgZ9/fHe4zfHG4RPeDpIib4RFYrIzqKNuTuXm0018fMIv5FJqikBnOlW4HLjGTGlCm4jI2+y1W++AiAPwXmfqVeaBRIDW/IJGLauYtbrrgxmLuOi1VfFA15tJAa3nhMk4iZFKLpSQFjNgB2hrrd/t9t9tze91JbzjqDke9YWe4M9x51hsM9v7llHwl98DyynpsD2RgVfi8d659J8nDyUmVRtwzMb9niv0Z/skhltLsPaTZcjAMpPSVGiDNDqYD1e098/rd4aB//zR7zagI1GkkF5wQtod9FSKRVZGw/5tcgZF1UyhuCsVNobgpFDeF4qZQ3BSKm0LxIYXiQ0qGteGmLsBqAYV+PCqdxK1l4FrAJckEYYRoTw5116gMHLQbADxNUWJpBhYyCwbZKJyH+DhDlmQmq5tsmTYBZi6SuMXjNx3Djb787vH3nYpJ8e234pHZp8gePblybMr1u5fUD0vzxqW+OIwQ7JJs1gxYy0UrmXkzF6WFC78Pg4XzpfF7TDhOMC48sxUk5DQp8ruHPisoLTMMcG1jGCi3nAAuekkfv/viwrJaGu/uoZz3Mgp9cXAGA69tm0VipHSYeHo1415qLxSJm5gsMoREZ5bnqR5tbxMruZx2rous2DaFeCnorngqnm7v4O+ueEoi/S2WSK5WX9ioNli3VHIQUcwVR1kGq3XFWbUFGVh74HxdUFineB7GLMzOlyynfL6QQjmCTOCANw7vUuULVC3udSZD4lAxyx46ClB8H/qUsnF+ZUiWyMnt2mkcJNHpiefSx3zN/A7sZDh+Su8daB3fA6ovjNuXXZAE196/OqzaU3I67O73B8FwIGX/2aC3tzvdD+TOTnd/d5+XceawNoBiMzeRWSYXK0P/lRaPQk9EiQeN/AcCQd4A2ZusjwanLd5czdcmp20dMI17liWmbTVNy68gANqCVz8/OBWDPREB8wt+Lq+XhBC7F+d4QqkZpTYm9cTMDeETGHi4Fv3KBOLw6MX44iUlBmdHf7s4OscnorXiW+MY1uqTWSa8mDSDm+X1BGj5xiSLKE3EU0v1KSYkbTVsG4bmm14gi54Lm36hhx19TY8maUGJb8uVSrR+HHZUZwsZH57NZQ4sniLV90ViNv+fjpGRprn70kryqZgp6avsSUeMqwyeoA1E0X9BqSNS+/r0QFDAlcFMmM8oLBDIe0trH7Uo29qoIeRlUynkHOD8HpDr5QUFH5pm0wsra7EsWv2AZyO5NneThtBYpAsALeoQtIwWEGOWUVkPsBQhshELR6QuDeCJy3YVYjUhk+HulWHmME/4nScLfQ+/O40APy5PrXrxXlnn07xcwmjE2ijVZBHJlsrc2baq1FU6PrIoFfkb39347sZ37+m7yy/P7AaRfcupT2819bmIZQH5Zhw8V1KfjK0nRqZqG5mlFqPILarpbYr045sJHPudiqk98kXKX79ifmRC+Qrz40of5vm0XHktQ3+tC2KQ5WhmYDZPRsx3zbFZ9mZR7ayO9iLJpiEMNF6TIgI1M7FICiEhsqyIY+JE6i3hJ0rHj3Ixk8BHyesrBgFpVNQ9ZvVnk0luMslNNNpEoz9NNNpkkhvf3fju/6bvfjaTrLhib7F5ki7mc5ktjKXZ9+bcPxpUJ/jrDVxW1XK2QsRElWM57czBmfZ7016w56mBLwf+cGc/6HvDvtzd6+31poP+ntOM9Ze1H1dO1vaphr6NHlnESOLeI48rYhiXzpPEby//QbyZCgjWePG2zJshc4j0qsod+/trTi4kiXgl40WZIelWDhnXMiJMQ9s5tc3KtnyE4Bq4GNMxhDDxy3NBoEJnp8zGBDkvzQJ0s4U7DnJMxTjK8l0KfPeiAhwyEkQJZc0JDCukvbeAcj5Q4Az2Guj8FbNTq6JflMmLM5rxS96KOfroKUWOXmXuu+vWd49juxNwbhT8iYVeU+3IGAaAgsBgVpV3bvLzTX6+ifGbGP/niPGb/Hzjuxvf/d/03S/Iz2029On8HA3unZ+jbacrqlzqBZ/A+q3TdHYVywGbt0g8r8h4ubnMwTmvgCkRQ2nBGEIXfEfOdnmiS2/fhP6tQyflKCE0vLSPNNxARVDNbUemYXUKL04+0Em97SnksgZyzHE/MhdqIManx7ak6LBQs5Ds1oAcEzcitkfZ6mOBn6VcHtJcJAVgjcls0Rkwa0P8mE5SooB4pO1Rb3OQZWl+mNdFFt3+8rkYQp+YyzrxfXY0tBfgdGmK9uBIeQGczuLMzegr18DrCEIV2urtihNq1hfPlczo9BxvWjz+8c3kSfMqiuY7FSEVBXR6GybCGDYuF/CpE4eVLCmuZ8z4uLVFQj4jzAHHn+JzpcRl87TcGdCYRUqdFAMA9bp6XGrHV+9VRHGv0zoiuh368TYktC1b/Z5wjONiIIzNpQ66CfJT7IrDkKCHD7dTGztFru3EZVrOSzbm9VAm/lJScw01l6npJ0tcGNFeeubIjQfHJRIy0iytBw9u6LkNelQ54QlRXeaBJGH5aG9seaXWHsxHi55L9Np8/BS/4eOD7W7C4JXQiH+RL46FN0sSrb4TgkyH3ODyuoAXPZgtPrPoske4/W6DJdcM6YYu0kHm7yUcIzbGZM7ScTaSIFGLfeOSP7Nm4fM/88m5n1tz5seXiJrU0k88/WCeaUCXBnQNBmjLvwlKZFjwbfNTFHQajg3goNY/I4FltIF7htZaVGfy29yHQoMHVs0R+nRkvoxqgLOfBL+g1lUbwDBl09VWH74LS4siU0tY5TrAsgRX+Y0SBMQluRl+q3UoCpJ/tPnSjMf1cslJHC2+Nkp/Akn+OLj7OyHeBmn+jEhj81tadjyrfwzmqL6yYn/cpnFzpXGdzvpc48YYncW/+85WeWVr5cLVsts+9FbU8qUoe2tp5a5R46rR/+3dnMblG3v9ZfW2S3ltpD13VvZdFyaa9yW+5OaCQxDILNjitAm8z20NsbqkzPe9FP7FW44fXN5BnbwcwPbTJJRGMucfmaJI481CxYtRqZI5iWSL0C6Zc3RIs4QkBitjQtd8oyiDG8lITsOI9EbbJeXIkkHcFDuENfTdqpTGMmLoiDdKqNgDVNDaAB34wbu3iV0kOIfJnJLJiMMSgFAIzOdFTNYPtos5rF/chVJ+qL3CBFMviWNVyiLhcqTqVUYWgj+aQoer5GyuTwLa5wg91QCjO8YCFmm7ySG9vIEj9UTO6N4CBTRn+fT/XbSBgO5MRSlZNjIBFAVNpHp1PFmhCGKxxrw81Umy623bSW9TWxChkt2Yz06n1+m6XMLieZroHFbZIH5hfoOs8QteS9dLqm2dX//Xy6xrUqW6ndKyKrFcmMrZLFBcOtUCBdqPzN2pGSZFr25uaNGNSvZbegzspxWdy6u6GudVDHvJrgaHT0748Zm9aPJErP2ts7X8lovF8aJeJ3Lw8Z1aMLbQIgx45vU/5se8sBtO7sTcnSs7ruyk0TqF6WHWFD/b9qqxznN6QVY0tT+MNjcrVpnku3v4d+T8hD8UClNjw2jEz2+ccv0Xbd5Wl4jlJ5JU+wFiR7P/AgV7l70=
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 Workflow' (update-workflow)"
---
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 Workflow</h1>
<MethodEndpoint method={"put"} path={"/workflows/{id}"}></MethodEndpoint>
Perform a full update of a workflow. The updated workflow object is returned in the response.
## 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 Workflow","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the workflow","example":"Send Email"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> </span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unique ID of the object","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the object","example":"William Wilson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of what the workflow accomplishes","example":"Send an email to the identity who's attributes changed."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>definition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The map of steps that the workflow will execute.
</div><SchemaItem collapsible={false} name={"start"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the starting step.","example":"Send Email Test"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>steps</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.","additionalProperties":true,"example":{"Send Email":{"actionId":"sp:send-email","attributes":{"body":"This is a test","from":"sailpoint@sailpoint.com","recipientId.$":"$.identity.id","subject":"test"},"nextStep":"success","selectResult":null,"type":"ACTION"},"success":{"type":"success"}}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Enable or disable the workflow. Workflows cannot be created in an enabled state.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trigger</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The trigger that starts the workflow
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`EVENT`, `EXTERNAL`, `SCHEDULED`]"} schema={{"type":"string","enum":["EVENT","EXTERNAL","SCHEDULED"],"example":"EVENT","description":"The trigger type"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>attributes</strong><span style={{"opacity":"0.6"}}> object</span><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Workflow Trigger Attributes.
</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Event Trigger Attributes"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unique ID of the trigger","example":"idn:identity-attributes-changed"}}></SchemaItem><SchemaItem collapsible={false} name={"filter.$"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSON path expression that will limit which events the trigger will fire on","example":"$.changes[?(@.attribute == 'manager')]"}}></SchemaItem></TabItem><TabItem label={"External Trigger Attributes"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A unique name for the external trigger","example":"search-and-notify"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Additonal context about the external trigger","example":"Run a search and notify the results"}}></SchemaItem></TabItem><TabItem label={"Scheduled Trigger Attributes"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"cronString"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A valid CRON expression","externalDocs":{"description":"CRON expression editor","url":"https://crontab.guru/"},"example":"0 * */3 */5 *"}}></SchemaItem></TabItem></SchemaTabs></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
The Workflow object
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Workflow ID. This is a UUID generated upon creation.","example":"d201c5e9-d37b-4aff-af14-66414f39d569"}}></SchemaItem><SchemaItem collapsible={false} name={"executionCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","description":"The number of times this workflow has been executed.","example":2}}></SchemaItem><SchemaItem collapsible={false} name={"failureCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","description":"The number of times this workflow has failed during execution.","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date and time the workflow was created.","example":"2022-01-10T16:06:16.636381447Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>creator</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Workflow creator's identity.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"Workflow creator's DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Workflow creator's identity ID.","example":"2c7180a46faadee4016fb4e018c20642"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Workflow creator's display name.","example":"Michael Michaels"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the workflow","example":"Send Email"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> </span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unique ID of the object","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the object","example":"William Wilson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of what the workflow accomplishes","example":"Send an email to the identity who's attributes changed."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>definition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The map of steps that the workflow will execute.
</div><SchemaItem collapsible={false} name={"start"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the starting step.","example":"Send Email Test"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>steps</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.","example":{"Send Email":{"actionId":"sp:send-email","attributes":{"body":"This is a test","from":"sailpoint@sailpoint.com","recipientId.$":"$.identity.id","subject":"test"},"nextStep":"success","selectResult":null,"type":"ACTION"},"success":{"type":"success"}},"additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Enable or disable the workflow. Workflows cannot be created in an enabled state.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trigger</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The trigger that starts the workflow
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`EVENT`, `EXTERNAL`, `SCHEDULED`]"} schema={{"type":"string","enum":["EVENT","EXTERNAL","SCHEDULED"],"example":"EVENT","description":"The trigger type"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>attributes</strong><span style={{"opacity":"0.6"}}> object</span><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Workflow Trigger Attributes.
</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Event Trigger Attributes"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unique ID of the trigger","example":"idn:identity-attributes-changed"}}></SchemaItem><SchemaItem collapsible={false} name={"filter.$"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSON path expression that will limit which events the trigger will fire on","example":"$.changes[?(@.attribute == 'manager')]"}}></SchemaItem></TabItem><TabItem label={"External Trigger Attributes"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A unique name for the external trigger","example":"search-and-notify"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Additonal context about the external trigger","example":"Run a search and notify the results"}}></SchemaItem></TabItem><TabItem label={"Scheduled Trigger Attributes"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"cronString"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A valid CRON expression","externalDocs":{"description":"CRON expression editor","url":"https://crontab.guru/"},"example":"0 * */3 */5 *"}}></SchemaItem></TabItem></SchemaTabs></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"d201c5e9-d37b-4aff-af14-66414f39d569\",\n \"executionCount\": 2,\n \"failureCount\": 0,\n \"created\": \"2022-01-10T16:06:16.636381447Z\",\n \"creator\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c7180a46faadee4016fb4e018c20642\",\n \"name\": \"Michael Michaels\"\n },\n \"name\": \"Send Email\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"description\": \"Send an email to the identity who's attributes changed.\",\n \"definition\": {\n \"start\": \"Send Email Test\",\n \"steps\": {\n \"Send Email\": {\n \"actionId\": \"sp:send-email\",\n \"attributes\": {\n \"body\": \"This is a test\",\n \"from\": \"sailpoint@sailpoint.com\",\n \"recipientId.$\": \"$.identity.id\",\n \"subject\": \"test\"\n },\n \"nextStep\": \"success\",\n \"selectResult\": null,\n \"type\": \"ACTION\"\n },\n \"success\": {\n \"type\": \"success\"\n }\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"EVENT\",\n \"attributes\": {\n \"id\": \"idn:identity-attributes-changed\",\n \"filter.$\": \"$.changes[?(@.attribute == 'manager')]\"\n }\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
Client Error - Returned if the request body is invalid.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><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