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

45 lines
14 KiB
Plaintext

---
id: create-duplicate-prevention-action
sidebar_label: Create a duplicate prevention action
hide_title: true
hide_table_of_contents: true
api: eJztWGtv2zYU/SuEPrWA8+pj7QIMmNtlgIe1DZJ0+5AZBi1d2WwkUiMpO4bh/75zKcmx/IpTdBgGNAVciby8PPfy8D40j0xBVnpldC+JzqPYkvT0S1lkKsbDpaUJaZ7txvwbdaKEXGxVEd7Oo/dBXkiRNEtEsVwjZFh0LG7GJFKTZWaq9Ei4siiM9fxohl8o9k5MVZYJTZQIb8SQRAUjETL1ZIUfK1frEnhqJp9NxyoeC2lJeBWWjsiPIT9RUkyNvUux4aBaN1DJc3G0RBkMHjwgHUjvrRqWnlxnYykclBqbk90yZ022d8lAG69S3pKHKZcqC+5wtM0Neen8qvnQ0TK+do7Ji4zg6Wfdy56rhXZoxPZiRl4oXpLDWEo6ooTs597zY5ymlyMXnd9GjQH1Ti7qdyJLf5fk/DuTzKLzeXhVlsASb0vqRLGBNu15ShaVW7Hy5ItjYswjF49hLj/5WUGgSgUJexaWOYcjczy75ronLFDJirDD+ekRhNnvEqiisoRAZwN2m7/MzKXtfvWldvmQMqNHDq5nd9G9ZEdi4cuX6embF0lydPZy+Oro1RmdHb0leXp09kP6Qr7+cfj6Tfw2Wqxtt4n2cXQrI8Kk2zC2gXX5moExfMqWGeMogxuFxHXMwKtkJuheucASODZVGXUEKBQ3N1nTVBhNDa9ETYNjtsaRtPF44GLDZjxuDukyZ3rJLMNsXFrLjOlvs7NSLYLqxtAaH3tfgE7xnZAjqTSDWTW50QuAmh6uMgjiVkBKa+WshTGVmdvweRd+YknGsK6tte3tYRzoA9VY6iSjHYR9BA/7plovVPJ1HGTHqgmt7j40CFyyiuepLDO/Y/feVsZxFG6UMncQZVrIgqoFdvbKB6S7E8oi/LEXXIG4U13xF6en/F8bysV9AR5jw0aUWSHFRGYqaUgafQ9L3zgs7eTkU+PSVaVS4FCswaGJ1JocUcmElB2CFZgkxciasmCNPMSVgUeKFw5nz3lUcMINoaiQo1036um+ZmVb/ezGpsyYXjoh+5W3L0kGNT1RD0g3MFNNdv9d3IazvopLVQ02VATYgoslFwSC+rUI2i6rWnbwVkAZSpNWtHuaZ3fyZKlSOG9YTcAVtmPcuMzLEmY/gQ71d21JpZoOygDKU+722uvp3m/cm2BfyxI6zJbb6IsZ68TQz6NQEaKiw/QXqak91g8ZbTpwKFjLAwAedCCc3yuFS6zX1et75JnRY+UFxiaoGHpa1k+ftPidJD/dkM2VZob9h1kHRcqdKgo5zOib7rzUum/r2v1ugNPL6yz0bRA0mhELa90HJd4/azVr2fbVtgT7TibiqoouaJVKHYzlyqvuN46fkl1RQX5KwfTNtNlA6+mQun/jpYvObrk/WCpsc2GtsS5a9CsjXm8zogd8ViO9XJOdIA6GNTDHki+tZuJomFYVVAkq4ZjCSvck4/ZXAsRbbiLrihwRghNNNT5cxsIgv3rJro21M+FMjn6WpaZ83FOLjF+fIKznOcMte2FC3VNIP8bbyVrh4k6WnXmr363bPC7p2U8uHFVpM6gYe1+485OTOZwhtf8oc1ocaxwo0JkZEYemE1koLJ5Iq5gmVWxailfG1yyPZJxTbDY+HdwEcaEhj9Tl1EhX7X+MJhiWWza1z/hQ3is/CwCHaBLIdks29ba/On3Nh1PhWBVanhUbxdYGMb6OQQgj1cOvTRy9MXfEjTZ+f5qZ0laPEXuceXD10BNfNMe1tVhslYOH5a6NTuRf6+TWG7llB7WtgTq0z2m1OYda/JAklqFL6dSwB5mVlSPOjk+PT1ciwseLqw+ie9nbpBSMbCZFLLlMZucFWsk45lIDEEVuEpXOBJPXIO0hquKgMSuUFuHMSU8UbhtHWXYWrg+h32BQOrA7+tC7CZTgu5dLvTJzyAexddzzh8jz/YPa//2DWhVuuBw7KTKpOLdVcXVeh+jb9XDBUXhvkOarxUEeS+fzoXT02WaLBQ/jPluOjP2HUBwCIxYgPnCXgaB5RzMmVkWxoxsGyOJZGWri9UTHqbha0Y05Oe6V7a/koctP1zccT+vPhbhkvMbKKZel+D2P/sI/vJgq44Zvijw+jzLUnSUyI2Qqvfz3DyXw7og=
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 duplicate prevention action' (create-duplicate-prevention-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 duplicate prevention action</h1>
<MethodEndpoint method={"post"} path={"/workflow_actions/duplicate_prevention_actions"}></MethodEndpoint>
Create a duplicate prevention action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - duplicatation_prevention_attributes, workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. 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":"Allows a user to select an already existing profile, or create a new one for the request."}}></SchemaItem><SchemaItem collapsible={false} name={"search_scope"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`all`, `current`]"} schema={{"type":"string","required":true,"enum":["all","current"],"description":"The search scope of the profiles to check against.","example":"current"}}></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_id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","required":false,"description":"The handle id.","example":"33f072dd-13b4-41e1-8ea0-16f2a59b57c8"}}></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>