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

107 lines
38 KiB
Plaintext
Raw Blame History

---
id: get-workflow
sidebar_label: Get Workflow By Id
hide_title: true
hide_table_of_contents: true
api: eJztXAtv20YS/isLXoE8YMp6WY4FFK1iK62LJPbZ8uXu3ABdkUuJDUXquGQSneH/ft/MLl+SHDtp7q4tVLQJRe7Oznu+WS574yRLlcosTOJT3xk6M5W9SdJ3QZR8cPacTM60M7x2ilvaebvn+Ep7abikKZjwg8qEFDqMZ5ESH+w4MV2J0G+BglZenobZClRunCut0uMkztTHbJRnc6Ksl8Ni0jBV0nfe3mKJpUzlQmUq1Twvxg8sFfogGNKiS4nZ65yc+iIJRDav2MCQVP0rD1MF0bI0V+AnW0VES4eLJS72HPVxGSU+bgUy0jTAm6uFdIY3TrZa8sgshXA8UvKcoeN1DqdK9qR7cNj33f5Bz3OPVLvv9nuDg2AaHMigPXVuSZBU6WUSa6WJYLfdpr+aXE9q/Ipk+qvyMqzlkZbijIbL5TIKPbbQ/q+a5tzUmJRRdBawkiy7JYllSpbNQrM2dLdFpCYrhZXF6UlLTOahFvhXiqur0xMxUzG5ifJFDoGEB1vRrFZDL3633fEO1JHr9w6nbl8GgSuDTt8dDPqdftA78g8GR84tzYBX0PTjJDdCWsZCSD1TKYgGSbqQmbnV626wSlqL88VUpWzzcKE0LA92S1XOpRZTpWJhFlN+g9UuuAhkGOWp+i/zQKtAa35OKhel5A1u2uCGNaq2Wqnkw8cIlxbaygs9FTL2mZVGHIgPYMQu0LRYt93tuu2O22lPOoNhezDsDFqD3qD3rNPvH/7TKfhK0hpfpYfd4T12xiO4jw8fRvC3NtzRkHqwQ1YkTyZngiaxGNA+5ZDTk/HryenkH5ScKtHKuxDis7x/k38KiKbavMPOs7bsDwIpfaX67c4gmPZVu/PM67YH/S6taZLWF6zqh3oZyZUgAs1lX4XeXKpI2L81cgz+2bsv9h/GCbszRm5JohUHlwr+NV7Ap0nE5AOSwvaUVqoum8tMYKBuEG0JQaOYAEQGs4tQa0yH0mOo+7X4EEaR8KkGLMIYE4mM9DIe0vBtylERLhBkWUKUKFxA/4xo63m4FJ6MkQoEdBbPMAq1KV8iWCges4IJWlaK86uJSFJxPpoc/yiodCidPdx5H+iP2xRPpEjxxoJGaRAsVYFKVewhLzzQi4lYHofgHFosTFn6Rd2Dj+DBzw4Gz7yD7pE3gAc/8zw5CI7aXqfX6T3cg9f9Zstib2DLUC4E/qYCRj7bJHLfGifVL1qGnaHhBNLzEiwW6jlMtOGwsL8inyUHyerO+WGewPtkhlWnqBG68JGWwxwGYRyuMXhH8iMlLOSSmNOZWmpjwWYOJoe2xWjTp3Qm0+zzlc3TyJFp1dYdoSomcGOSiFm7X5gzxBuiYJGkiulak1qhSNFpqFWz1iHgziMlcVsrU3zKzOYnXr6AwhkwkAmKET9dnr0WBsoIBK1Q0pubBYsML32fDSCj85q2DJIrJb2pZyWCRF6JZoEuNZ65bH2iV1qaBk4Tf8U6LZBORnpCvU2TBU3GnGWC2v99edWC8AwqvXAZQqRTv/UNRn7TKisdY1SdG8UOncxqPgbkvYRkRDb3PKU1Y+MIoy6UziOMjfMo2issMzqenJ69ZpvZ4TXXsHc49ztY1cSYVfdJ5bWEtGI5jRqoYpoksFO8YfQxjyS7o/7w5Vq+LnsAyqdxknFKNZiCkydizCxGTmlcHBEkWTaLrUuT8W9iPg1nM/UAcME50gw2XsiOr+9G+9eGYMPkbz83kY//hpSN3+O/T8YXr0cvcXl5/OP45Orl+KSZ3IuRn+Ca1rhdd8EkVgV8t3Ycv4cniYmdNapG792jomooykbEZkGswSyn1jdfIxbHk0uhaIU1ZcFtN7TzxeWmsGpdQaEfD4sgcSsduDbhkmaCMEK1p4C6b1VOHNQDIp8u0WJpTizkFpxko3AR4nIOlGSE1XW2zJgAkoskbvD4Tctwo6+/e/x9q2RSfPuteLSQscTkR0/eOhZyFfb6CKaRoL6qyVRBtFJl3VpcmDfs9bByPSrsxWWE0i7pZsuClV60kqk3d9FauIj7MFg5n1u/R5THKY0Lz7T/Qk6TPLt/6YucYJlhgHsbwwBPTDlx6jV7XKKe+Dmloa9nEC5Shuh2g3hpEl8a0TfMUnv2AOO8l1Hoi+MLOHjl26wSo6WTxNObiHttvFCkbmIyT1ESnXmWLfVwf59YyeS0NcvTfN804oWi2+KpeLrfw38H4impdGOjp6znm3oFXNpSiey4rc+eU+mlNdYf2KrW37ZVchxRzRXjNIXXuuJCZXkaU/UJrD8wXhdU1qmehzErs/U52ymfbqTQjgAJHPN20X2mfIGuxZ2lMiQOFbPsYaIAxfehT5CN8ZUhWWROHteEcdBEqyOeSx/yGvmOrTBcP6X3DrROH5Cqr0zYF1MAgqvo31xWHSo5HbSPuv1g0Jey+6zfOTyYHgWy12sfHRzxNs4C3oakWMcmMk3lamPpH2jzKPRElHiwyL+hEOAG6N6gPlqcNvYytdgKTps2YBoPbEvM2FJMy6+gBLSHqH5+fC76hyJCzs/5vpytKSF2ry5xh6AZQRsDPSG5IXwGBw+3Zr8CQJyMX4yuXhIwuBj/9Wp8iSuitRFboxje6pNbJryZNEeYZZUAtH1jwCJaE/HUUn0KgaTthu3A0PzSK6DohbDwCzPs6ltm1EkLAr6NUCqy9eOwpVp7QHy4t5AZcvEUUN8XXHaVeDoCIl1m7kuryadirqSv0ictMSoRPKU2EMX8FUFHQHsDHIlAkCOUwUyYzaksUJL31vY+KlU2rVGlkJd1o1BwgPMHpFwvy6n4kJj1KCy9xbJo7QOejeaa3E1qSmOVrpBo0YdgZLSCGtOU2nokSxECjdh0RObSSDxxMa7MWPWUyenulWHmJEv4mSdz/YC4O4+QflwWrXzwXtng07xdwtmIrVGYyWYk2yrzZDuqNFcR+EBRKvJ3sbuL3V3sPjB21x9e2BdE9ilDn84m9LmKZQ79plw8N6BPyt4TA6naQWarxRhyj3p6C5F+ejNBYL9TMY0HXiT8+hXxkSnlG8yPSnuY+9Ni57Uo/ZUtiEHWo5HAvDwZMt8Vx2bbm1XV21ztRZJOQzhovAUiImumYpXkQkJlaR7HxInUe8JPlI4fZWIukR8l76+YDEirou8xuz87JLlDkrtqtKtGf5pqtEOSu9jdxe4fM3Y/iSRLrjhaLE7S+WIh05XxNPucpJUCA0RxVKl6gcumWkcrREyUGMtpIgdn2u1MO8Ghp/q+7PuD3lHQ9QZdeXDYOexM+91Dp17rr6s4LoOsGVM1exs7sooB4t4Dx+UxnEtnSeI3t/+g3lQFlNZ487bAzdA5VPq2xI7doy0nF5JEvJLxqkBIuoEh40pHlNMwdkFj02IsHyGYIS/GdAwhTPziXBCo0Nkp82KCgpekAN105Y6CDKKYQCmcrFwljL0oB4ecCaKEUHMCxwrp3VtAmA8UGMHOkJ2/Ijq1JvpNSF5ckMQv+VXM+KOnFAV6idwPtu3vnsb2TcClMfAdG72m25ExHAANgclZJe7c4fMdPt/V+F2N/3PU+B0+38XuLnb/mLH7GfjcoqG78TkGPBifY2yrLUos9YJPYP2vYTqHiuWA3VsknpenvN1cYHDGFXAl+9kJ5RD6rGPo7BcnuvT+TejfOnRSjgCh4aV5pOEGJoJpbltyGZan8OLkA53U259CL1tSjjnuR+5CA8To/NS2FC1WahqS35okx8SNiu1RtupY4CcpF4c0V0mOtMZk9ugMmPUhvk0nKdFAPNL2qLc5yLImH+S6SqPb3y6LIXSHLNvU98nVMF6A0zUR7cGR4qMfOouzMKtvfPpTVRDq0Da/rjijYV3xXMmUTs/xS4vHP72ZPKl/iqL5m4qQmgI6vQ0X4Rw2KjbwaRKXlTTJZ3NmfNR4RUIxI8wBx5/jS6XEdf203AWyMauUJilOADTr7ePCOr56ryKqe63GEdH90I/3oaF92Zj3hGscNwNhbD7qoC9Bfo5dcRJS6uHD7TTGisi9nbheFnLJmlxfysRfCmquoeYyNf1kjQuj2mvPHLnxELhEQkaatfXFixt6bo0edU64Q1TXeSBNWD6aL7a8wmpfzEeDnkv0mnz8HL/h44PNacLkK6FR/yJfnApvniRafScEuQ6FwfUsRxR9MVt8ZtHliHC77RpLrlnSDV3AQebvJQIjNs5kztIxGkkA1GLfhOQvbFnE/C98cu6Xhsx8+xpVk0b6iae/mGda0KUFXZMDtOXfFCVyLMS2+XiQTsOxAxxX9udMYBmt5T1Da2tWZ/L7PIdKgwdWzRH65dD8GFYJzl4JfkCjyzFIw4Smy1d9+C0sLapMDWUV+wDrGtzkN0pQENf0Zvgt96GoSP7e5CWJR9V2yVkcrb52lr4jk/x+8u7/KePtMs2fMdNYfEvuxsvaRqDu5M8tXtvcvuNvaxT+xFOOVYbSaFS49WIUUye0jGRGXs1R7c1DxY3/UsmMsN8eeVay4EhEj07hj/aOCc34640ULEu0amFE36/Q1nSxsuSAMcCS7Eq/7acttJY5LN8Sb9CLxR7MQn0YHa7As18T25BdwjLnZFhxUhgboGuxyGP6/gps5wsh4VL3eIQfai83iQttWawKXSQM/cpZRRSTq5EILe5I0oU+C2hPGe1qzfD3rAW7a7uhLL2sOmDvVIJc0BlxSh4bJ63vow1vc+cqWlIniKwLAKZqK7w6nWxQBLFYQy503Ek627eT9D6NBRFqj4z79FqdVtvldgH3l4nO0LvWiNMH++VZ7ucruNK6B95Uu+j3fd5vqwPB+v0l7UHRmrlpM0w3d+2U3RzGD82HJnNwRY9ubmiHgvqbW7qNzpza3+u3VevCLZ/9IskvPyS6k93HF/ZU/hOx9X8HsJXfYmctXlVNtYPLd4p6cXCMjhU882YJ82MemO2U2pSNFw7UC5Ut7g9jMqq8o6zaC8iOxPEfj6vghA==
sidebar_class_name: "get api-method"
info_path: docs/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Workflow By Id' (get-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"}>Get Workflow By Id</h1>
<MethodEndpoint method={"get"} path={"/workflows/{id}"}></MethodEndpoint>
Get a single workflow by id.
## 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><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