mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
45 lines
13 KiB
Plaintext
45 lines
13 KiB
Plaintext
---
|
|
id: create-profile-check-action
|
|
sidebar_label: Create a profile check action
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWFtP4zgU/itWnqGFuezMIK20zIiRutq5CLo7D2xVuclJa0jsrO1Qqor/vt+xk5JegDJC2pcFVBL7+Jzv3I+7TExFVnpl9CBLTpLUkvT03ZpcFfRpRun1acqbyUGSkUutqsLbSfIpEAopqkgrUiYWsqX2cuqSk8tkbux1Xph5s+OS0UFi6Z+anP9oskVysgyvyhLEe1vTQZIa7Ul73pJVVag0wOtfORa8TBwklZKf/KIiQDGTK0o9ZAIKlPGKHO+2kscNpv0PqKxD7LxVegri3NhSAlVS1yA42IK9bp/hjMRKd999iXDEhAqjp0540wMzupVlVbC816/zo3evsuzw+PXkzeGbYzo+fE/y6PD4l/yVfPth8vZd+j652xC3jfZpdJ0VYfJdGNeBfVY6cx2HT6SjTOCwowLmxLP0kD6pPYFMZ+JGFnCzyE2NF6WDBEfOBc7QQNp0pm6oa+yJMQXJGG25rAuYO5eF28I/2IlXKAhumApjhTZ+TYXACoI1jVdQ4WzXASCtlYs18+2Uf6pFoGTDbXJbE3m5nz9HQDWDzQoaRyCPObRBRLouWUBjUpCsYHCSbTs8ChDMGE6xYj6TXriZqYsMe1VFMGAOzwm6Vc5D6srVqvHiekC0gu+x706cJ2zZgaaynhA/ZgDSxQrpjagDeB1v+OvEEp/6iQwCaq98OLCj3N2FH8buKlStWCBeHR3xv3X4Z7dVjP6WFBmNLEHwK14LlS75v6i9cFF7MJKeW9XOI0sBp1gDp4ncmhJJYHDSitrhA6kixdSaumKOvOTEXPkZVh18r3KVCou6FYpaJacP5cHzbc3Mdtq5yVpLOiP7c6aWWTZuwpPsWLqxmWuyj9fiXTibUrxi1WKbwKZZxl0hZmtg37qkLSxIFdDFoWM9i1kUUCIpVLFWX59n2QfjZMVSOG+YTcAVxDFuJLMLRfLJANrX3o0mkTXt1XOUp9I9qq+nW7+VN0G/NU1oP10ukysz05mh36Z8upeaEttXUtP62ij00PnYeenrPQDu5RAwFJHhCutFfP2EZjB9wgtctm/oQAy0bJ6+afEHSX4aki2V5gj7T6cOd62qSk4KelHJK66PiW7M78bwXtl0oZdB0HJGLWx4P4yj03F/NGw2uu2bXQ32o8zEeawu4lDUOiiLwgF5YO6p95zuajR9yxHp222zhTbQoXX/7sJk8zDdX0wVxJxZa6xL7kZRibe7lBgAn9VoLxdkb1AHwxmoY8nXVsc5utZx6skwgKUUTrpnKff4JEAschvZqShRIbjRxPXJqhYG+m6SXRhrF8KZkjCGgWrO7p5bdPzGg9Ce9wzfJCsT5p5K+hne+huDi+s3LWAc7o3tKg64YCAXfFTbAmdn3lfupN9fwgpS+6+ypLuehicByyyIuCb1ZaVw+EZaxfERi9KKPGrdhHci05JSs3WjHQZyoUGPnuXUlN3CcVajQ5RojdBvxPjS2iq/CAAnJC3Z05p1vBx1ty/YKxFHl2jlJFaKtQ1knIeBCCvx4XNbQIfmGuOw589fF6a28TGMrxwA5/dX6bPWTzunxLU5cL+mtWmgl70AditxU3G272X7Xp82bk+dO1HnZrL/xUDp3LDROBCj7se9o95RJ/u/np1/EaffB9tRBB3bTZFKHol5ZAyRJNOUxwo2TWkylS8Ex6tBi0MFhW+xy2YKbiZ9o5BZXFHZVsh6wt2CQekQ0MmXwTBg5Twrpe7sPPXVzMaQvSovT3+nE43LPb1fFVKFq1/I0WWT55eboediGdqR6ewzLhE4s1xyKP1pi7s7XkZEW06v0X0+h+zCAZIZz6jIvGtaMOKI/XDIyJgcAccZvlkmuZDHE6cpl9ZHaUedKvb928WQk7L5qgpu4zNWznmowedJ8jd+8WJivQ7fZ/H6MikwtdSoq6CJfPnnXzqJuc4=
|
|
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 a profile check action' (create-profile-check-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 a profile check action</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/workflow_actions/profile_check_actions"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Create a profile check 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":"Finds a profile based on selected attributes and values found in the session."}}></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={"ne_attribute_ids"} required={false} schemaName={"array"} qualifierMessage={undefined} schema={{"type":"array","required":false,"description":"An array of ne_attribute_ids.","example":["33f072dd-13b4-41e1-8ea0-16f2a59b57c8"]}}></SchemaItem><SchemaItem collapsible={false} name={"handle_type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`session`, `attribute`]"} schema={{"type":"string","required":false,"enum":["session","attribute"],"description":"The handle type for what should happen if an existing profile is found.","example":"session"}}></SchemaItem><SchemaItem collapsible={false} name={"handle_id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","required":false,"description":"The handle id. When handle type is session, this is the session id.","example":"33f072dd-13b4-41e1-8ea0-16f2a59b57c8"}}></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> |