Files
developer.sailpoint.com/docs/api/nerm/v1/create-update-profile-action.api.mdx
2024-03-06 16:17:34 -05:00

45 lines
12 KiB
Plaintext

---
id: create-update-profile-action
sidebar_label: Create an update profile action
hide_title: true
hide_table_of_contents: true
api: eJztWG1v4zYM/iuCPuetb7tbgAHrHTogw+5atLntQxcEsk0nam3Jk+SkQZD/PlKyfc5L2/RQYF+WAqklUdRD8iEpZ811AUY4qdUo4UMeGxAOvhUJft8YncoMLmNa5R2egI2NLPxoyD97SSYUK700K4I4E7W8EzPLh/d8qc1jmulltWL5pMMN/FOCdZ90suLDtR9KA4jAmRI6PNbKgXK0JIoik7FH2H+wdPSa23gOuaAntyoAwejoAWKHZyIItMdJsLRanzytMB2/QSYtYeuMVDMUTrXJBaLiZYkCnT3Y2x4az4E1trv2IMBhEWRazSxzuofK4EnkRUbnnZ2lgw+nSdI9OYvOu+cncNL9CGLQPfkpPRUXP0cXH+KPfLNz3D7a19G1ZphOD2HcBhZ4YZlogr2Ubs5EljHh8NiopNVYZxk6FxKWlARlS2+PgAsTz+UC2j6OtM5ABJqloszQy6nI7B7s0UGYTCKoSinThinttpB7VRs82UnXsmSb4Rv/Ib/ZAmkaGHE6GNC/bRBXT0UwsBbFEKJTFiKTNOepzf9n8Tuz+CAffoTGt0Elw6AYjUFjqdE5VjKNOw0rLX4hhwSbGV0WpJGmbMV1ZjH2MpUxM8hYT+dCzODdfE3KDvrZznWZEb1UAubHXC2SZFrRE8xU2KleKjAvZ+EhnFUSNqpqbBH6NEkwL4T1Al59HZK6ZGCqoFxoNMmWHXQUosSkkNm0KShv9uyzPGlUMut0U5n8cYQbk9kyVPs6gY71d2VJUB1yszJDGCNWh1BLB7l90V4HT24vb7x9W5bAcbbc8wc9V4mGX2e0uxfrHJcfhILtuQmeqGA5tU648giARwUEFbKgsMF6F4af50LNXokCle0FdNhIierpWrE/QNDTGEwuFTHsP+w3HW4fZVGIiKbe8eRG60tHV+63U4xeXnWh90FQa8ZaWOk+quX+VanZ6bbnhxrsJ5Gw21BdWJeVyhuLhQPPQ+UOem/prlrBdYpM32+bNbSR8q37d9q66Twv9ydJ+WOujNHG8s0kGHFxyIgR4jMK28sdmAXWQb8HzTHgSqOIOHh3Vkj0JMMBPMXgd9o3GffyTQDoyH1klyzHCkGNJsxHTS308u0ku9PGrJjVObg5SS0p3EuDHb+KIFpPa5reHgrt7z2FcHMc9XcuLrYf3hSmVSeop3GH9R6yPkilyXDz3LnCDvv9NbpBKPdV5LDpKQwl4tIrACpKfVFI3LwQRhJBQlVqxIPZFb+5iHOI9d5bzNiLM4Xy2LSsnFFciGgltogceyMaOCF8MV5l3coDjEAYMJclGXk/aS/fUVgCjrZQEyUyiqz1YpSIXghnwsNvdQUd60dQCAO/f1np0oRHTr4mBtx+f3m6qgN18Jq4dRE8rmvtOuhdrvztCtzUBalSTSAp8OGsk96gN2il29er2y/s8ma0HzXUXi+yWNAdlO5oPnIijqmPY1axXCcyXTHih8aegiULfYmrTCrm3QpqIZHKVMIIJKYZ4GWeQClPIP5lNPZeJ2LnQrVWXn/93bnXNhl9zJtzoAs10n6RCUlVKeTFukqu+91wUxY9k15I0DklJm5aryNh4ZvJNhuaRhoZ4vTkexJ5SuMGEAndDJHuj7Ai0AF+d0zQSDwr/T1mtzhR+Qw7LmMqaC/KTlq14+b6bkyZUP0igLGjPUYs6SqB30P+N/7hQIcq6X82oPk1z/CuUGI1Q5mglz7/Ag5f4wU=
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 update profile action' (create-update-profile-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 update profile action</h1>
<MethodEndpoint method={"post"} path={"/workflow_actions/update_profile_actions"}></MethodEndpoint>
Create an update profile action
## 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":true,"description":"The description of the workflow action.","example":"Updates a profile with all attributes collected during the workflow."}}></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></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>