mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
45 lines
15 KiB
Plaintext
45 lines
15 KiB
Plaintext
---
|
|
id: create-registration-workflow
|
|
sidebar_label: Create a registration workflow
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJzFWN1v2zYQ/1cIPdvxR5J+GNiDu2VYhrUNYmd96AyBlk42W4nUSCqJYfh/7x1pSZTtNAn2sARIyOOR97vjfVHbSJWguRVKXqfRJEo0cAu3sBLGevIXpb9nuXqIelEKJtGiJCqy/upYGWc64GYPLbvlKxNNvkY1yUSLXqTh3wqM/aDSTTTZuqnQgKKtrqAXJUpakJaWeFnmInGnDr4ZErmNTLKGgtPIbkpAEGr5DRKLwkpNilgBhlYbFM9y4iwTOcTEFYs02IAqCbnCDZnSBUdIUVUhQ+8Ic9cs8zWw/aGMTmIWCTUeBlmGKMwZHgOPvChzknR+ng3fjtO0PzpfXvQvRjDqvwM+7I/eZGN++X55+TZ5F+16iIjbypyCCLIqyNRXki9zIJC/CeOHi+cAf1kDQtRMaSaV7cIVhoE/kpbT/Zld9LVMBFidNuDzBsONTGUd2V0hxSamw1GG5AW8Xsgn3HUo4VBAQ9+hGCuso3sv/9Iu0Q9JM6WSxvvQeDikf12JV48l3jQarmZlVmGw3PNcEM1FQfQ/OPxLfZynn2W+8dZ8+moLIf8CubLraHI+xil/DKdHp9QwXxRpuyZbgH79Bs/6dKjcGdA4/QT7YG3mPEnAGDdd7HpNgniZ3X6SC9YYTE1goecYly5FnrOl90k8Eed2fcbIZmzq3QFji6EUdlemlG7bZNrBFmYFrjXfIBZhoTiZLY6s9iRq859hf+A2WXdRP5/GeCni/U3GhqKjR8Gh1b1LbRwxrKQfWtQRcctVbFWMB2sbB+E9vZv/0Z/Np/O72ag7HXen593pRXd62Z2+6U7fdqfvutP3hLJCcAHqJdkkThSlHusoGOUJGTJGk8Vp5fMAxiuu5Mp4lpBdVRqvIeZpOINHzCQhAcMA4xMPCmiVcyPy1EYKmtqo3Ns248LXj6zK0QH8WMh7YV1eqm8jT3kZ04WI1HFIIHNLAoEo1QYg9p1Eekj28j3Ziky4YYm4SXt/yTwPSc5shRdbE7v6H1IbOxwuhPY4XGvs0iwQfgqIlrS3yQEYskUw9Wolh3vrUDWQ77PyfqEtBS3lXjh71gQfMHGy5nIFHbrCgkdHJ5BWOlzCiFqtXEKrKa2CxI5WdRFXw3IO2Lhku2D2gMEXhW/t0OdZPya8bmgU+sVB5LqoRJhBXHYUcvuONalkGDIPXLgox5sKzmnKSX3SIizpbcTsXKbQYllZMKdKJDqSoAvj+U2nWHYT1C44HdfQz+LmWNeeTJxmImG0RjGGFj9iGY4Go8vBeDgeBvb3Vj7ivdkXD2pfqNpWuRUoPn7Ftt4MsMdIWYc2XwvdJe1bEXcM5qAnDqaqeATmNftqNC3BQ2kP3oXdV913zXzdadqvi1Md1weeslvve6zPKteWUtNV+8HZa9otJeFzhrXo2FdqbNfS9XJ/0tZd72m+v4nLibnSWmksgQuvxOUpJa4Rn0Y/ZDPQ92gTtwfV0WArLakPl6gauntKTTk8JuB2mlcp9/MOEUjkMbIpK/AW+AqYpy+p8FM/7fnDyJsprTfMqAJfFq49QFTsQSuKofoKaU2Rb5TKZz9OXWM0aFqFQfiujNsOArOFM41xt1PpHHetrS3NZDDYov5cWnKk3RnWnbrsnKEPDLCrwM33XAvyDB/fDbvXN+Po1NRCJQX66XE/59gZPUFYnZych1WYwApMt6jZgvAlWFTsxgFcAtegpxVp93URLs/oPjyOkKm5HlKKtHVsOPdM1D+4we91FzdX30EiDPz7ywbLmR+6Vwxd/W374r5qs1f4YDh6A7/sRdp2csG708f7/rlWv9aOXldCZook0zV6047OhmfDIGo+Xd1+ZNOb65M9db3IEi6pDa2MvwffujMMDlaoVGQbRretKkOPMLQMrjIhmTMSYFODHknFnGIHowXwkUag9pg/Xs8dVvLPgstg5dkvHx3E2zYuX/DNxF891Y9BmXMh3bOafHy7j5DwewrV3pMxgl62prBC7u12yQ3c6Xy3IzL6gibHXLSR4PwSN+BjDd2LfPY7bAish92fEyZizyv3vDhMLZT8/I5pQunop7yLIPJvPs/m5M77b0F4ZbRHczIE/Z1E/+AvTpTPce6DEXcum2O9rzAXIY8/l35+AJjlnz4=
|
|
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 registration workflow' (create-registration-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 TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Create a registration workflow</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/workflows/registration_workflows"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Create a registration workflow
|
|
|
|
## 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</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"profile_type_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","required":true,"description":"The profile type the workflow effects.","example":"33f072dd-13b4-41e1-8ea0-16f2a59b57c8"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`Enabled`, `Disabled`]"} schema={{"type":"string","enum":["Enabled","Disabled"],"required":true,"description":"Whether or not the workflow is enabled or disabled.","example":"Enabled"}}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","required":true,"description":"The uid of the workflow.","example":"my_uid"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","required":true,"description":"Name of the workflow","example":"my_workflow"}}></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</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\": {\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> |