mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
45 lines
16 KiB
Plaintext
45 lines
16 KiB
Plaintext
---
|
|
id: post-workflow-session
|
|
sidebar_label: Create a workflow session
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWG1v2zYQ/isEP9ux4yRuG2Af3CLDMqxtEDvrh8wwaImy2UqkypckhuH/vjtSr5abxeiKAUMTIBHJ4+m5491zJ26pyrlmVih5HdNLmitjPyn9JUnV45QbA/O0R2NuIi1ylAKZd5ozywkjj4UgMZWkZStDL+/p/pKh8x7NmWYZt1yjyJZKGIA67XCjQM1fHdebzvs+iTQlIEXsmpPIvzweuDzG/x0MRCTEuCiCUeJS0KX5Vyc0B+MSlhreoyZa84zRyy21mxwBLJVKOQt2JsylthDd7eZhOzf2rYo3uKXWZrUDZZGSlkuLSyzPUxF5Vw4+G0S+7b5LLT/zyMKrco2Ot4IbXC2tWJSefPkOETeEjdVCrkA4UTpjAIs6BwK9Pdy7yi6uv19B2NpVwaXLMBbuDNcw/MDBgkSkvBozf0x+OD/whkL8hQDbMTODUCn2Q9gI042TR4yqJfcLoBHGdn1CPsp0QybhJJewF95C7nyoVRoMbWEzDXBMa4bxKyzPzD+D3j2D2nw37LfMRus2amYByNJZbg4FGItjgUBYetMKtbYRoIY/sSxPw5nzJ7uo1C7QKpSELIgIruHBgPM6IsPTwenFYDQcDWntTMNTQNKRvSnO8QPyRY9mkKECXr84YltvyiFTY9Kam62Fbk/RkNBejdLfUowB2wFzzL4STT0RoNSKdztwsxUWnUz3+Lg/wmUvobnJgVvDMY2GQ/zXjqirpxygAE+WosQqYO4Hlgqc8ylM/0Maeyn5sBhDvKIGd3hfJuQfXK7sml6ejWDInprDjpajOPRozvz3OfInJ/4ATkSycgeBlWfDcrEoThICW3qqzAHSA0cfM8CwkuHRgo2AW64WVi1AsbaL8l2wPLmb/dafziazu+lpezhqD8/aw/P28KI9HLeHr9rD1+3hG0QJHLVooF6iT4C/kNKtn4Fsj9CRC3DZInaBDyBfYSVVJog0xZXTcAwLqB+NEZA/l80JSAPIT1DUmAtdHEZq9RZwtVFp8G3C4NT9g0shAMKzkA/Cen4qTyONWY7V4EHEXkJydLdEEIBSbTjQc2gb96eLLtJPW5EI/5gDbrQ+HDJLm1PebVl4bTnZtn9/tvLD/kLTH/trlV+qBcQfWuxyqvDJHhj0RWMYzIr297ZLZ2OhLgn1zIPw/iwnQsIsojWTK96aV9C9oeqIx043lyCjVitPaOVMbSCKg1d9xpWwfABWIVkvmAIwD0Xhc/0YeDY8I17/aBTExV7m+qwEmI28bBnk93UtcbKZMo9M+CyHk2roqcpJqWneaJUaGfOzEft/NGJVG3Z+qPN6y2JyG2KP9ImTvgZB81XGwckxbZeS/GPiP5r3Y6XEdi19T/c7bt31vi33J0r511xpreBLfDcPRlwcMuIa8GmIQzLl+gF84veAOZpbpyEXCFRfJyHcY+Bmwp8i7neao4x7vkPk+MousgnJ4BTYipMwv8TCjxcEQb6ZeVOl9YYYlXFoH7A9AFTkUSvMofIIcU2VFyCIgWHXSAf7HS0WQeN9Ee4wnE5BbG1tbi4Hgy0YzKTFyNmdQKEp68wJHPoA2gjY/MC0wFAICV2JBwOL2wfKogwCs9vAeXGC9yakZCMfUg4YKwN+3fkrC8MjqCJ24wEuOdNcTxyacz9vLk/xAAKOplB1HmgULa5L/DWJF8KGwT/8WrZtM/WFS4ABf3/ZQP0KjxS9imd9W1+gXNV0dehLodWO07OEvb5Ixuf9i1enr/rnF+NRf3mWRP1R9GZ8lozHLGFjut+TH7+rMLbot5vt9Ut1tdre+5ftmndKwE/6/mH0LWSi0MeYtCGRTk+GJ8MGKX64un1PJjfXBz+ZykUSMYlfGc6ErAtfZgS4j2QqFsmGYG4rZ/BbG/IAVomQxKcEh54VCAd7NaRGIEMO3+IIqrgEfX898xmD9JMx2Vh57ra1BXZbM+7zV7Qh4jGqBnnKBNaLwGPbgvbuO+npr2/XSI2wuN0umeF3Ot3tcDpc2iLXxMIgtdVXrd/E931Xugct+MI31WUylEKHEhT5rmRcz39gBWcx5DriDVveBVT9GWqt93ZqFlbVsGMSYZ17VnbeKCk3H6czpM3iChmCxV97M+wZ8e8l/Qt+YaBC8fT3zDi/pSk0kg6KHMgEvfjzN14lXrA=
|
|
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 workflow session' (post-workflow-session)"
|
|
---
|
|
|
|
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 workflow session</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/workflow_sessions"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Create a workflow session
|
|
|
|
## Request
|
|
|
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"run","in":"query","description":"Will run the created/updated workflow session if successful","required":false,"schema":{"type":"boolean","default":false}}}></ParamsItem></ul></div></details><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_session</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}}></SchemaItem><SchemaItem collapsible={false} name={"requester_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","required":true}}></SchemaItem><SchemaItem collapsible={false} name={"requester_type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`User`, `NeprofileUser`, `NeaccessUser`]"} schema={{"type":"string","enum":["User","NeprofileUser","NeaccessUser"],"required":true}}></SchemaItem><SchemaItem collapsible={false} name={"profile_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"The profile this workflow session will be working with. Only Applicable for Update workflows"}}></SchemaItem><SchemaItem collapsible={false} name={"profile_ids"} required={false} schemaName={"uuid[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string","format":"uuid"},"description":"The profiles this workflow session will be working with. Only Applicable for Batch workflows"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></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_session</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"workflow_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"requester_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"requester_type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`User`, `NeprofileUser`, `NeaccessUser`]"} schema={{"type":"string","enum":["User","NeprofileUser","NeaccessUser"]}}></SchemaItem><SchemaItem collapsible={false} name={"profile_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"The profile this workflow session will be working with. Only Applicable for Update workflows"}}></SchemaItem><SchemaItem collapsible={false} name={"profile_ids"} required={false} schemaName={"uuid[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string","format":"uuid"},"description":"The profiles this workflow session will be working with. Only Applicable for Batch workflows"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`api_request_sent`, `approved`, `assigned`, `attempting_to_start_workflow`, `AUTH-STATUS1`, `AUTH-STATUS2`, `AUTH-STATUS3`, `AUTH-STATUS4`, `AUTH-STATUS5`, `AUTH-STATUS6`, `AUTH-STATUS7`, `AUTH-STATUS8`, `AUTH-STATUS9`, `auto_assigned`, `batch_completed`, `checking_for_duplicates`, `closed`, `completed`, `courion_add`, `courion_extend`, `courion_terminate`, `courion_update`, `duplicates_resolved`, `failed`, `fulfilled`, `invitation_sent`, `ldap_provided`, `new`, `non_employee_created`, `non_employee_updated`, `notified`, `pending_approval`, `pending_assignment`, `pending_courion_add`, `pending_courion_extend`, `pending_courion_terminate`, `pending_courion_update`, `pending_creation`, `pending_fulfillment`, `pending_ldap`, `pending_notification`, `pending_profile_select`, `pending_request`, `pending_review`, `pending_status_change`, `pending_stored_procedure`, `pending_trigger`, `pending_update`, `processing`, `profile_check_complete`, `profiles_selected`, `rejected`, `requested`, `reviewed`, `soap_request_sent`, `started_workflow`, `status_changed`, `stored_procedure`, `un_assigned`, `waiting_on_workflow`, `workflow_changed`]"} schema={{"type":"string","enum":["api_request_sent","approved","assigned","attempting_to_start_workflow","AUTH-STATUS1","AUTH-STATUS2","AUTH-STATUS3","AUTH-STATUS4","AUTH-STATUS5","AUTH-STATUS6","AUTH-STATUS7","AUTH-STATUS8","AUTH-STATUS9","auto_assigned","batch_completed","checking_for_duplicates","closed","completed","courion_add","courion_extend","courion_terminate","courion_update","duplicates_resolved","failed","fulfilled","invitation_sent","ldap_provided","new","non_employee_created","non_employee_updated","notified","pending_approval","pending_assignment","pending_courion_add","pending_courion_extend","pending_courion_terminate","pending_courion_update","pending_creation","pending_fulfillment","pending_ldap","pending_notification","pending_profile_select","pending_request","pending_review","pending_status_change","pending_stored_procedure","pending_trigger","pending_update","processing","profile_check_complete","profiles_selected","rejected","requested","reviewed","soap_request_sent","started_workflow","status_changed","stored_procedure","un_assigned","waiting_on_workflow","workflow_changed"],"example":"completed"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"workflow_session\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"uid\": \"string\",\n \"workflow_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"requester_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"requester_type\": \"User\",\n \"profile_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"profile_ids\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"status\": \"completed\",\n \"attributes\": {\n \"text_attribute_uid\": \"static text\",\n \"date_attribute_uid\": \"01/15/2020\",\n \"profile_select_attribute_uid\": \"Profile Name\",\n \"multiple_profile_select_attribute_uid\": \"Profile Name,Second Profile Name,Third Profile Name\",\n \"contributor_select_attribute_uid\": \"User Name\",\n \"multiple_contributor_select_attribute_uid\": \"User Name,Second User Name,Third User Name\"\n }\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> |