mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
45 lines
12 KiB
Plaintext
45 lines
12 KiB
Plaintext
---
|
|
id: create-set-security-question-action
|
|
sidebar_label: Create set security question action
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWNtu4zYQ/RVCz4mda3droECzixRw0d1sY7d9SA1jLI1sJhKpkpQdw/C/d4aUFPmSxFkE6EsdxJHImeGZ+zCrSBdowEmt+knUi2KD4HCAboBxaaRb/l6i5d2rmL+joyhBGxtZ+Lde9NnTCxAWHf0GHvFPxSSg5nIwtVHvLlpo85BmelHt2Gh0FBn09J90sox6K/8qDRIaZ0o8imKtHCrHW1AUmYw92u69ZQCryMYzzIGf3LJAgqQn9xg7OrMwrJuTaHm3PnlcYTqcQSYtYuuMVFMiTrXJgVBFZUkERzuwN+00nKFodHftlwBHTDDTamqF0x0Sho+QFxmfd36ennw4S5Lj0/PJxfHFKZ4ef0Q4OT79IT2Dyx8nlx/ij9F667hdtK+ja60Ine7DuAnsm9F54TxdadEQcEH2m8sEhdU5CrIkeQiy3aiwAlRCv3ZBJB0GDyaeyTm27TzROkMIAZdCmZGlU8jsDvT+XqhC0iGVUKGNUNptoPei6GBV5hM0Y52OG3AtDJICb4qm7WxaOj87yJ5BNJvySe/GWHamy6y2gSgLQpzpqdw08emaEDrpvLmfT8m1/zAkS3JsCN6zkxP+swnr+rGgQCeL1KTsNBBzyCSveZzR/wn3zgm3N2y/J+Nug0hBTqFEo8xKKQUphjRxmhBXFOogpkaXBUvkJSsW0s24QJPvZSpjYSixfNYVMMV3szUL22vnKtQNqgTN95kakmRchSclK9ixXihKyxeLxT6cVa1oRNXYJmTTJKG8gJCiXnztErJ1KjOfKkQX+mOyoQcfRSgpKWQ2Bkc2nJTu7ZZ9Nk4akcI6zWI8Ln8c46ZktoLEvh5Ah9q70iSIxnZFBGNguQ+1dJjbF/V1+Oh28sbrt6EJHqbLXXSvZyrR+POUuTuxzmn7HhRuro24yONibB248gCABzmEBIogsME6CK+fZ6Cmr3iBy/Ycj0RfQfV0o8RvCPw0RJNLxRH2n7ZF+yCLAia89I4nN1JfOroyvx2T9/KqC70Pgloy1cJK9vM4Wo33r0rMVre92NdgP0EibkN1EceiVF5ZKhx0Hgl32HlLd9UKb1KK9N22WUPrK9+6f2XW9dHzdH8ylT/m2hhtbLQeBSUu9ynRJ3yGB7cBmjnVQc9D6hh0pVEcOIpUo0BPMnrBxxg9p32Tci9PAshH7iK7EjlVCG40YX3S1EJP306ygTZm6QdRN2OqBbt7YajjVx4k7XlP86Wn0H7uKcDN6K27NbjYLt1txvUU2wyK9S4xWm8o631VmoxkzJwrbK/bXZE1QLmvkOO6o8ijBE8vEbk2daGQxDwHIzlOQnFqyIP2VZhHEOcY653b19CTC0X01LusnLJ7ON5K6hQ5tUjSc8T4AnYPcIJg0FyVrOvdqL09YO8EHG2ixlmsFGvryTgfPRGthIdf6kI61A+oCAZ9/7TUpQmPEZucA+H26bp3Xftr77S4MQ8e1ry2DfRul5R2Ma6Kzt67g5/ZpUo1K8BBEXCcdk46J62M/Hp9+0VcfevvepSQ1psiBh5TGbn3KsQxt3rGletEpkvBsaOp7VBVIzvTrpBKeJOjmkuKdq5yDJ4yEWneZ1DKB1f0pT/0HuHYz0G1dqor/SsX+q3xt0n8w/8jEIKKu263yEByCQvZs6oy8W47KEKuvZSLFM0zTmbiXa0mYPEPk63XvEykhhNg9JRxPv6JASHhaZJy4wGXrEHQ5XjICJk8K/3ss13QuOQGjquYi+CLtKNWvfl2Mxhy2lT/8CBnMo+BBY8f9N2L/qYfetFFcyX166soo/mipApINEEuf/4FZ9Q7Rw==
|
|
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 set security question action' (create-set-security-question-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 set security question action</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/workflow_actions/set_security_question_actions"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Create a set security question 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":"Prompt the user to provide some personal security questions and answers."}}></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={"number_of_questions"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","required":true,"description":"The number of questions the user should answer upon login.","example":1}}></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> |