mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
45 lines
14 KiB
Plaintext
45 lines
14 KiB
Plaintext
---
|
|
id: create-approval-action
|
|
sidebar_label: Create an approval action
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWG1v2zYQ/iuEPrWAYztvaxdgwNwiAzysTZC424fMMGjpZDGRSI2k7BiG/3vvSEmRLTtzhnwohiRAIpHH43Nvz5FaBSoHza1QchgFF0GogVsY5LlWc54OQpoIOkEEJtQid28XwWcnxLhkvBRk3El22SgBFqs0VQshZ8wUea60pUc1vYfQGrYQacokQMSsYlNgfsOI8diCZjYRptTF8KmafLdIRJgwroFZ4ZbOwCYoPxecLZR+iHHDiV83EdF7dtQaRStjpTPQptOa0yqFHcP1kolUVsQidG6aQMZF2pauXLFvXgM5oFbgXGVgl4uywtimaxDEhmNKx6ksTwHD8G5wPTSl0B6NiJ8twTJBSzKQqLXDCpT9NnzfxfBaPjPBxV1QYS53MsG4E2j4pwBjP6loGVys3KvQgLlidQGdIFSoTVqaQg+kpZN694YyZRWYMEFz6ckuc8Dc8ZBwT/QWOhjDaWh2y1svWCCihrCxGu1GYQocR1RBUaBApwV7M6Epa2vbbfOldPkUUiVnBl1P7oJHTo7Ehaencf/DSRQdHZ9Oz47OjuH46CPw/tHxT/EJP/95ev4h/Bist7Zro31CF/PU7ITXGGEq3gVyE9mNV/lUobFWGZascnWDsdcMM4azmVZFThppiMrTYp0xk0NIGc+oNLpkQc5n8Gq+JmU7/WwSVaQR0yAj0P/N1VyHiZhDE+lUoRXc81jMi9Tu8fNwp1+JiCql5DN04QYypwo3Ng8iz/mUhl5x51rrc1uXHjcTJIWsrMbXQVBpxpwode/HgUCssC5YWw1k7X4Ip8mRVnwFn/T79G8TxuUjZh6RXiVKbMcZqhIRK6koeGOdN9b50VgniiZleuJ5gZuJWkjQz9fhLpxlGdaqKmzY8HELOicZJ+DUVyFBX8cihc0T1YYdtBWidCePCbfow2lhX+7ZvXlSq2TGKlLjcLntCDcWc31CeT6BDvV3aYlX7WuzNINrzZe7UAsLmXnWXguPtlU3zr4NS+AwW+6Ce5XISMGvM3fgQ/7E6XsuYXNsjDtKWEyM5bY4AOBBAUGFzCussd76188Jl7N/iQLR9hw6bCh5+XQl2R/A6WkEOhOSMuyt2/4g3favUs1Wtz3b1WA/8YjdeHbBW1IhnbFIHNV1ovuS7qokXMWY6e22WUEbSte6f6el685+uT9Jym1zqbXSJliPvRHnu4wYIj4tsb3cgp4jD7o1aI4GW2hJiSPRNEz0KMUXeAzBrTQvMu75kwDQlm1kA5YhQ1Cj8ePTmgudfLPIbpXWS2ZUhldZklpQuBcaO34ZQbSe5hTdy3Plzj05twm+9bYOLqZX3z6rmxtWiPONceEpdIrLEmtzc9HrrdABXNqvPIN1V2IQEZFaAhAdoSaBi+dcC0oNz0e1uDe4zOyAhxmEqvV5YOTEmUR5bFdGzKS/7Yd4r0VrNZk3JnxhoYVdOoBTwMu9HhRk3t24OX1LAfE4mkJ1fMgostaJUQk6IRzxD79V3DlSD0B3Z/z7y1IV2j8G5GWK/c3TNfeyCtHOA+LGEfCwfrXtoFc9JTUOSYeieSLtkpwaZFqOtDmuZh0hY0WOoOTy9hx3+91+o5i/Xt58YYPrYTszsBCqSRZyOuGSbS47eBjSKQFrlmUqEvGSUQ4q7FgIA+OFs0xI5kIHci6wUAgYOQCLGPCqQKCkS9Lgy3DkIktlk3HZmNn77Wob7OqJKd4+eP3vPnh57qDzVC9PuaDm5ElyVXLs3XbtE6W2WBZ5KiFmRvHVasoNfNPpek3DyCaaqG38xKWO2XAB8IiuBsh6D7Ck7PJ5djQiUCSeFu4gu92dqH/6FYOQOtqzsuNG87i+uh0RIZaf8LC8aI3mCzpL4t+L4G/8xRfl26T7zkfjqyDFw2KB/IIyXi/9fAcSB9L/
|
|
sidebar_class_name: "post api-method"
|
|
info_path: docs/api/nerm/v1/nerm-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 an approval action' (create-approval-action)"
|
|
---
|
|
|
|
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 TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Create an approval action</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/workflow_actions/approval_actions"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Create an approval action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email, workflow_action_approval_email, workflow_action_rejection_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).
|
|
|
|
## 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={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>workflow_action</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"workflow_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","required":true,"description":"The workflow the workflow action belongs to.","example":"33f072dd-13b4-41e1-8ea0-16f2a59b57c8"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","required":false,"description":"The description of the workflow action.","example":"Require approval from another user or a group of users with a specific role."}}></SchemaItem><SchemaItem collapsible={false} name={"page_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","required":true,"description":"The page the workflow action should render.","example":"33f072dd-13b4-41e1-8ea0-16f2a59b57c8"}}></SchemaItem><SchemaItem collapsible={false} name={"archived"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"If the workflow action is archived or not.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"skippable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"If the workflow action is skippable or not.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"requires_comment"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"If the workflow action requires a comment or not.","example":false}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Expected response to a valid request
|
|
|
|
</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={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>workflow_action</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"workflow_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","required":true,"description":"The workflow the workflow action belongs to.","example":"33f072dd-13b4-41e1-8ea0-16f2a59b57c8"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","required":false,"description":"The description of the workflow action.","example":"Require approval from another user or a group of users with a specific role."}}></SchemaItem><SchemaItem collapsible={false} name={"page_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","required":true,"description":"The page the workflow action should render.","example":"33f072dd-13b4-41e1-8ea0-16f2a59b57c8"}}></SchemaItem><SchemaItem collapsible={false} name={"add_requester_as_owner"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":true,"description":"If the requester should be added as the owner of the profile to be created.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"email_attribute_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","required":false,"description":"The attribute storing the email address for the workflow action.","example":"33f072dd-13b4-41e1-8ea0-16f2a59b57c8"}}></SchemaItem><SchemaItem collapsible={false} name={"email_addresses"} required={false} schemaName={"text[]"} qualifierMessage={undefined} schema={{"type":"array","required":false,"items":{"type":"string","format":"text"},"description":"The email addresses for the workflow action.","example":["johndoe@gmail.com","janedoe@gmail.com"]}}></SchemaItem><SchemaItem collapsible={false} name={"new_status"} required={false} schemaName={"text"} qualifierMessage={undefined} schema={{"type":"string","format":"text","required":false,"description":"The new status for the Status Change workflow action.","example":"Active, Inactive, On Leave, Terminated"}}></SchemaItem><SchemaItem collapsible={false} name={"archived"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"If the workflow action is archived or not.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"skippable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"If the workflow action is skippable or not.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"requires_comment"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"If the workflow action requires a comment or not.","example":false}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"workflow_action\": {\n \"workflow_id\": \"33f072dd-13b4-41e1-8ea0-16f2a59b57c8\",\n \"description\": \"Require approval from another user or a group of users with a specific role.\",\n \"page_id\": \"33f072dd-13b4-41e1-8ea0-16f2a59b57c8\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"33f072dd-13b4-41e1-8ea0-16f2a59b57c8\",\n \"email_addresses\": [\n \"johndoe@gmail.com\",\n \"janedoe@gmail.com\"\n ],\n \"new_status\": \"Active, Inactive, On Leave, Terminated\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
Bad Request - unable to complete.
|
|
|
|
</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"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"InvalidJson"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":"Invalid JSON syntax. Please check your syntax and try again."}}></SchemaItem></TabItem><TabItem label={"ValidationErrors"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":"The <object> failed to create/update"}}></SchemaItem><SchemaItem collapsible={false} name={"errors"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":{"attribute":"can't be blank"}}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
|
|
|
Internal Server Error - returned on unhandled exceptions.
|
|
|
|
</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":"Sorry something went wrong"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"Sorry something went wrong\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div> |