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-identity-proofing-action
|
|
sidebar_label: Create an identity proofing action
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWFtv2zYU/iuEnlrAsZNe1i7AgKVFhnnY2iJxt4csMGjpyGIikRpJ2TEM//d9h5RdX9OkCLA9NAESiTzn8Fy+c6HmianJSq+M7mfJaZJakp76GWmv/OyTNSZXenyWMkHSSTJyqVV1eDtN3gdiIbVQLYOoWw4hA0tXDAoSuSlLM+VV19S1sZ4fzeiGUu/EVJWl0ESZ8EaMSEQNMiFzT1b4QrlWlsDTcvPZtFBpIaQl4VVgHZMvQD9RUkyNvc1x4DDyDVX2XBytVBwuVVxup0bnatxEJ3QO01WyrvHqgk2O9tlSNc6v25CbTQtaC01VlwTHPTv71Hct0QGJ2ngxIy8Us1TQjLKOaED7uf+8i4B4OXbJ6VWytLk9ySXXncTSPw05/85ks+R0Hl6VJUTZ24Y6Cez2EMhbsKxUaXBA78ZxbOeJSwuqJD/5WU2IdlQJZ8IxwAz87nh3y9uPYFDZGrHzFnaDGO6oJLRKmgYEnR21NyHI8FrZ7tdfWpePqDQIGlzP7qI7yY4E48uX+fGbF1l2dPJy9Oro1QmdHL0leXx08kP+Qr7+cfT6Tfo2WWwdt6vt17VbWxEm36fjpmK/ygkFKkTZgiI1jfZCOmdSFUA1Vb6IqIJfc1WSmMhSZZyJzLZKRazILpsgbVqoCa17e2RMSTJmdC6bEv7OZel2DOjvVZgzcSlUAL0A6YYNQdQCJ0OPYNOBerIIP+xEVwOzER4vjo/536Ye53c1oITTlqScSjIaLlqcJ98h/cSQ3guJb8H0RRQpEBRrEDSRW1Ohb5hQswPQASMpxtY0NUvkJReRLoVD7FWuUmEB2oDoWo7pyXzNwvb62RWmKRleOiP7ba6WWTZs4Ul2KN3QTDXZ+xNxn55tHq5ELXVDN8ER3C1dIAjilyFZloeNvrphBx8FLZEUqhxKDx+OGv94zx7EyUqkcN6wmKBXOI71RjKv2t/9AHqov1tLouiYm60Z0lo526e18lS5e+31dOd38ibYt2EJPcyWq+TGFDoz9POYubuYBrB9IzVtrl3jRE3TofPSNw9Q8EEBgUARBa50vYyv7wupx1+JApftCXVEX8v26aMWv5PkpwHZSmlG2H/YcjqJu1V1LUe89IQnr6Ted3TrfoeBsqraLvQ0Giwloxa2sh/Udf9qxWx121f7Guw7mYmLWF0wKzc6GIvCsZxVu4/prkbTxxxI322bq4FAh9b9G7MuOofp/oyTDY45t9ZYlyyuoxGv9xnRh35Wo71ckp2gDgYemGPJN1YzcDRMA9CzEi90l1LgdI8y7v5JgPjIXc3ORIUKwY0mro9WtTDQryfZpbF2JpypcKFhqimHe2rR8dsIwnreM3xdq02Ye2rpC7z1tgYX1zt0mXFgcsFJLsSpsSX4C+9rd9rrzeEJqf0HWdGiqxFNqGZmRFyXerJWYJ5IqxgjsTCtyKPlLcQTmVaUmp1r4yCQCw16nmvVWMfLX4rbE8y2bOc165c2FroHBUeEu549a9jOq+v17UuOTNRjnWgVKDaKrQ1knIuBCCvx4ZdlER2YW+IbGv7+NDONjY8Ju5tBcPHlMnW+jNXeSXFjFnxY49p20BNfAdbL8apIKJ0bVpchEE896R53j9dy78P5xR8CN9Td+OGI5aZIJQ+krGmIIZTlpo4UE5XJVD4TjBSDBoP6Ba9iVygtgoNJTxRwzfWMlUTOESZ7VkoHKCV/9AfB/4zySuq1na9/edjWev4lw79/t/gffLeIycmTS68upeI2EKvQvK1mV9vJxTXrcD1DRSi4GIJvPh9JR59tuVjwMvLWchG5/lK1Qg0BA8mMp3HUl1uaMTAiRI4GrB2Tl02YHbcbAresyHGWchO5l/Z6rV5/+ng54NLTfpJBijCPlVMe3/D3NPkbv3gxsTOF7za8Pk9KzGcNOghoolz++RcER/gM
|
|
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 identity proofing action' (create-identity-proofing-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 identity proofing action</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/workflow_actions/identity_proofing_actions"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Create an identity proofing action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - identity_proofing_action_configuration, identity_proofing_action_mappings. 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":true,"description":"The description of the workflow action.","example":"Have the user account associated with this profile validate the identity data."}}></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> |