LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/create-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: create-workflow
sidebar_label: Create Workflow
hide_title: true
hide_table_of_contents: true
api: eJztXAtv2zgS/iuEboFui8ixHcdpDCx23cS9zaJtcolzvbs0wNISbauVSJ0oNfUF+e83M6Relpu42e7eXiEUbW2JHM57Po4o3zoqFglPAyVPfGfkeIngqXirkg/zUN04O07KF9oZXTn5Je1c7zi+0F4SxDgL5hzRHMaZFDfsxo5jN0G6ZOlSMBgcJMJnaRIsFiJhXPpMpyLWTMfCC+YB3AskDU3EvzOhUzZT/qoDi2vhZUmQroCBW+dSi+RIyVR8SsdZukSmdDzK1xtFXPKFcK7vgD9L5wWQcUa39BVZcEZpkokdx0MqMsVbPI7DwCP5d99rFOfW0d5SRJzuhuHpnBYvSVw5kkcCmFM3UiSw3s6tk65iAYpQs/fCS+FWnKBW00BopELjR8UoDYqQC2ddi1OQH0cyNSdd3JQ2EJ94FIc490KA8iYRD0LnLucAKDcpBT4ICJoDUjxlMFDXiHYYw1FE4IlmwGwUaA3TNZri5PgNmC8MwXQp3pEwEclwL6UhVUos0AzUpG7QwgopzVUSAf1TpK2XQcw8LtlMMG/J5QJGzVYsi31QuVwQJWICl+Xs7HLKVMLOxtOjn3Nn6DT0afTY1KeQWYT2OTmevJmeTP+Jnlqqrri6SfFIChVvLGiUBoIlYi4SIT2wO6g78LezYiYD4By0mJuy8IuSm7532Hvefb4/fO7t9w+9YbcHnzw+nB92vd5ebw/Xe5zfbFjsLdgy4BGD/9HF7+7u1og8tMZx+Q2XIWeoOQH3PAWLBXoJJmo4LNhfoM+ig6RV57xZKvA+nsKqsywVOveRjkMczgMZrDFYSNdUQsRjZM6klrTBIjm0+AQZJRVNn9IpT9IvVzZNQ0fGVTufCVU2BTdGiYi1h4U5hXiDKIhUIoiuNakVChWdBBp8dgkeWgnos1BwuKyFINbyhM185WURKJySHJogH/HLxekbZpIdg6BlgntLsyDyh9Jw3ycD8PCsoi2TRAtJb6tZCZOmV1QTyM8a7rlkfaRXWBoHzig9g05BDswiLEU97TjzREU4GebEKpDpT8WnDgjvYHr3gjgAkU78zncw8rtO7lHwActGZhQ7clKreQlF4wIkQ7KZ5wmtqbqEMOpc6CyEsTILw53cMuOj6cnpG7KZHV5xDXvljuIIVjUxZtV9XHrtHaYkPgtFNW/MlAI7yYbRJzQS7e4Hmj6u5euiAGM+lSqllEqVl8onxphZDJ3SuDhEECfZ5jzUVZPRd2TelOTt4iuv3+SF5Ph6vVBVqyQRrJn8+ksT+eTvkLLh++Qf08n5m/Er+Hhx9PPk+PLV5Lie3POR93CNa9ytu6CSwhb43I6Tj+BJbGpnjcvROw+oqBwKZSMks0CsgVlOrG++gVicTC+YwBXWlAVu29DOo8tNbtWqggJfjvIgcUsduDbhombmQQjVHgPqoVUpccQc8J34FCeCgINxC0qyYRAF8HEZQDohYXWVLTNmDpIzJWs8ftcx3OirH7//qVMwyX74gT0x6C558vSaylfFXp+AaUhQX9VkIidaqrIBABv22q5cj3N7URnBtIu62bBgqRcteOItXcDNLsR9MF85X1q/x5jHMY0zzwBoxmcqSx9e+jxDWGYYIOBuGLBgHROnXrPHBdQTP8M09PUMQkXKEN1sEC9R8sKI3jBL5d4WxvnIw8BnR+fg4KVvk0qMlo6Vp5uIe208E6huZDJLoCQ6yzSN9Wh3F1lJ+ayzyJJsl8pDoegue8ae7e7B3332DFXa2GUV9bypV4BLGyqRHbfxHu2M7q5LFkioWu5rSllwQAWOrANYHsOF5pWmASVmogyJKj6obFqsKSq4HDPew8g4B8YNWLuuscdiz3XoabFhA9FVAN23h4CMDA8ioArEsSCjiSny4lyXnYz9UFnKq9IXVQdgqpGFtvbmjbmmdejWoSvDSxC6Ln+12DRz+p1xTqgSsZLazOh3u5s7OIV/FrXyEW2r+xtT2yDMgo2T4w4r7Xp5CXhzIST2DiFUMhDI7EZgVn0f7Pe7PW9fHLr+3sHMHfD53OXz3sAdDge9wXzv0N8fHppaiFtzmH6kMlndioOTCBOG2Fniqbm019+8Oc+iGdRGRMJBJHR9k8yWXMO2Sci8D+DXWO0jCAa/zBLxO/OAq4DW/AxVzgrJa9x0gRu7v9tkpYIPH0a4uNBGXnzqzEIs44i1hggwYheoW6zf7ffdbs/tdae94ag7HPWGneHecO95bzA4+JeT86W22DcW3mNnQIIq4nrrvt6DJI+np0XLYssm4JbtvHv4x4BYa+kdQJ7ng+Gcc1+IAeT5+Wwgur3nXr87HPS3b+ltWNUPdBzyFe0a6su+hm0WFyGz/5u+RNuUbpvSbVO6bUq3TelvCMG2Tem2Kd02pdumdNuUbpvS33BTunnDVrXBplbJUYg1l02SBLzWZecizRKJ1WfeOFGE9TyQpMzOl7RT7t9IwXYEkMCR8reIs5ewa3EXCQ+QQ0EsezCRAcWPgY+QjfCVIZlnThpXh3GgiU6PveA+yGvkO7LCUP3k3gegdbJFqr40YZ9PARBcRn9zWXEg+GzYPewP5sMB5/3ng97B/uxwzvf2uof7h9TGicDbIClWsQlPEr5qLP1XbB4FHguVBxb5DygEcAPo3qA+XBwbqKmINoLTug2IxpbbEjO2ENPyyzAB7UBUvzg6Y4MDFkLOz+g6X6wpQbqXF9izBWiG0MZAT5DcED4FBw82Zr8cQBxPXo4vXyEwOJ/87XJyAZ+QViO2xhK81Ue3VNRMWkKYpaUA2L4xYBG2JuyZpfoMBOJ2N2wHBuabXgGKjpiFXzDDrr5hRpU0Q+BbC6U8W38fdERnBxAfXIt4Crl4BlDfZ8qc5Xs2BkQap+4rq8lnbCm4L5KnHTYuEDyjzrqG+SuEjgDty8OA8wxCWdA5QiwLmOS9td5Hqcq6NcoU8qpqFAwO4HyLlOulGRYfFLMahYW3WBatfYBno7k6d9OK0kilK0i0sA+BkeEK1JgkuK2HZMkCQCM2HaG5NCQemY8rMlY1ZVK6e22YOU4V3fN4preIu7MQ0o9LohU3PgobfJraJZSNyBq5mWxGsltlmmxHFebKAx9QlAj9Nnbb2G1jd8vYXb95bh8Q2bsEfXpN6HMpeQb6Tah4NqBPQt4jAanaQabVYgy5g3t6C5F+eTuFwP4gJI4HvIj49SviI1PKG8yPC3uY67O885qX/tIWyCDp0UhgHp6MiO+SYyd/ujbo7jVXe6mSWQAOKjdARMiaCVupjHFQWZJJiZxwvcN8JbR8krIlh/zIqb9iMiCuCvse0/1pkWSLJNtq1Fajb6YatUiyjd02dv8/Y/deJFk/7Glxks6iiCcr42n2PkrLGQxg+VGl8gFucRSuilaQGCswllNHDs6s35v15geeGPh84A/3Dud9b9jn+we9g95s0D9wqrX+qozjIsjqMVWxt7EjqRhA3EfAcZkE59KpUn69/QfqTcQc0xo1b3PcDDrv4DnYHDv2DzecXFCKveZylSMkXcOQstQR5jQYG+HYJB9LRwgWkBclHkMIgC97Lgio4Nkp82ACgxelALrJyh3PUxDFBEr5aqRdJZBemAGHlAlChahZgWMF+OxtjpgPKBCCXUB2/oro1JroNyF5do4Sv6JHMZNPnhAY6AVy39/U3z2R9knAhTHwZxq9ZrfDJTgAbAhMzipwZ4vPW3ze1vi2xn8bNb7F523strH7/xm7X4DPLRr6PD6HAVvjcxjb6bICS72kE1h/NEynULEckHsz5XlZQu3mHIMTrgBXQoZiRSfv8EwPfNvNj3SZU3IIBg0f9eMMt2AeMMtdh8dBcQJPqhs8pbc7A51sSDfmqB+6Cg5g47MTu53okEKTAH3WJDgibtRrj7GVRwLvpZwf0FypDFIakdnB81/Wf+gynqKEzcMTbY95m0Msa/KBXJdJePfbZTGEPiPLJvXduxqMZ8Dpmoj20Ej+Oy54Dicyqzd+zaWsHrg7a75ZcYrD+uyF4AmenKMHFt//8nb6tPoaiqb3KQLcEODJbXARyl/jvHmPk6ikJCpbmJ+nGdcej2C8MHO48Z28EIJdVU/KnUMmJpXiJEHBj7Ouv8+t44uPIsSa16kdD90NfLkLGtrltXlPqb7RRiCQ5oUOfAvknXTZcYBphw624xgrIu3r2FWcy8Urcj2Wib/k1FxDzSVq+ukaF0a1V545buNB0CIJHmrS1qMXN/TcCj3cNcEVpLrOA2rC8lF/qOXlVns0HzV6LtKr8/FOvqWjg/VpzOQqpqH2hT47Yd5SKS1+ZAxdB8PgapFBFD2aLTqv6FJEuP1uhSXXLOkGLkBB4u8VBIY0zmTO0RESUQDSpG9C8leyLMT8r3Rq7teazHT5CiomjvSVpx/NMy7o4oKuyQHa8m8KEjoWxLZJ5HgSjhzgqLQ/ZQLLaCXvGVobszqR36U5WBo8YNUcn49H5suoTHD2E6MbOLoYA2kYkXTxmA++M0sLq1JNWXkPYF2DTX5DBcVwTW+G36IHhQXyzyYvSjwuWyWnMlx97Sz9mUzy58m7/6OM12aabzHTWGyLLcfz8sfpJuXrKu2b5d/6ezl/0E8lWCG3fmvBwRRILNiNaTXxvrB7iGY7md71EvAv3KX6QVs7MGf5w49VQnHIU8y0VGm8ZSCoERULnqJKdjDbqYiqQ5wo1Bh4GRFa0NtECYQRD/ksCNFu+KgkX5lTEjebHcw1+N2aFNcyauiwt4IJ6UGqwL4AHvaBe++VbRBcgMucocuw4zwBwUYgijKJ3g9sZxF4P3soS/mB9jJTTD0lpch1oWg7UszKKwumPxShQzvkJNKnc3zGEXiikoweWAtykbYPOLiXVvJIKcg5vrOABc1ZP/n/EG3IgO5ShDF6NiAB2BRUM9Xrk2mDIhCTGuTyREcli107Se/iWCCCW3bjPnudXqfr0hYWruNGH7yyQtz+pGjld0jXXi0pHun8jr8+amMSt6i7MfZSkdfMbJlNU+LKKZsSsM1dYsMCLt7eYo8Nd+l3eBmoYgPn6rrcgOM3IGZ6bdTF+CAwvdmHO+7UvKdmmznNp1bYFzAzTP/u3rHXlZ7K2Sl2Mm02vXUi0x5KOL0oB/+OnHfwB2tPbJwGBtH1WydvtsKY98Ubu/wzqNB+QDHv7v4L9IwPzg==
sidebar_class_name: "post 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 'Create Workflow' (create-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"}>Create Workflow</h1>
<MethodEndpoint method={"post"} path={"/workflows"}></MethodEndpoint>
Create a new workflow with the desired trigger and steps specified in the request body.
## Request
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={true} 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 className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</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></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