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-ask-security-question-action
|
|
sidebar_label: Create ask security question action
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWNtu4zYQ/RVCz04cJ7vdNkCBZhcp4KJ7aeK2D6lh0NLIZiKRKknFMQz/e8+QkuNbEu82QF+aAIlEDodnbodDLRJTkZVeGd3PkvMktSQ9Xbi7a0prq/z8t5ocz16k/DfpJBm51KoqvJ0nH4K8kFpIdydcs0j83awSsl3m5cQl5zfJzNi7vDCzZsYlw05iKci/N9k8OV+EV2UJcLytqZOkRnvSnqdkVRUqDXC7t44RLBKXTqmU/OTnFQGTGd9S6rFnZdk4r8jxbLvzqMF0+AKVrQk7b5WeQDg3tpRAldQ1BDo7sDcdNZiSWNnu118iHDGmwuiJE94cQxk9yLIqeL+zs/zk3WmWHfXOxm+O3vSod/Q9yZOj3nf5qXz7w/jtu/T7ZLm13S7al9GtjQiT78O4CeyLNWXlg1ztyAI40sDN8ORMSQKORIBksZsU7pjx6rockx2ZfLQaX8OtEPIJ2XU3Y+js9CBLomo2YqX6EaabmrrIWqh1BWsLM1GbxvUA0Js70iN6qFSsj9dCF/SKR73Cq5I6IjXGZkqjmpyYKT8V2/uPePMXUY4ixJcTgOAlLki4wzquaznnf8EXQnpPCC4PyGLGM8PDTMGmB5iymUhhZ5gibTpV97RebGNjCpKRdnJZF/B0Lgu349f+3nwVyolWqTBWaOM3dg6qluxE5QOSp3lvGX7Yiw4Z4yJBnJ6c8L9NKJcPFcgEG7aioTDEvSwUj4WMTP4ntVcmtb1Z8S2sdhVVCgTFGgRN5KA5sIXBShsZBJkkxcSaumKNPNSkuRQOsVe5SoVF3gaaq+SEXs3XrGyvnxtSs6Qzst/maplloyY9QcvSjcxMg+KercV9OJtSXKlqsY3h0yxDXchIxkF9GxL4OldFKBXIxSYk27CDtwJKFIUqRqAnq8a1/3rPPpknK5XCecNqAq6wHeNGMTsBtS8n0KH+biyJqmn97JPWyvk+1Aqk7J6119OD36mbYN+GJXSYLTfJrZnqzNBPE159nJoS07dS0+bYkI9zmo2cl74+AOBBAYFCERWusF7H1w9TqScvRIFp+x5HUV/L5umzFr+S5KcB2TKcTtl/eOp0EnenqkqOC3rVnVdan9u6cb8bIXplcwq9DoJWM7iw0X3Qwftno2brtH2z74B9LzNxFdlFHIlaB2NBHNgPyn1okQ4+XY2mzzkyfffYbKH1dTi6f+Gly87Tcn+wVNjm0lqDlmo5jEa83WdEH/gsd8fXZO/Bg2ENzLHka6s5cTRMQ6JnBV7oIaWqaZ1frXUg3nIX2YUowRB80MTx8YoLg/x6kV0ba+eh2/dTlppxuGcWJ34TQVjPc4ZvlpUJfU8l/RRv3a3GxXVxfxy1V4XVlaCdxUIXHOVCrGpbQMfU+8qdd7sLeENq/0mWtDzWiCjgmTkRc1NXVgqL76VVnCeRnFbi0fomzROZlpSanSvuIIgLDXmcXU5NODycbzVOihJHJOwcMr6IPQAck7RkL2q29Wa4Pn3N0Yk41oVWwWKj2NogxvUYhDASH35uiXQQWu/QWP84RwsfHxN2OSfC1eOV+rKN195ucaMfPOzw2nbQv7kIPnEP7O27fu0ZbG477eXlkctXDKN0bthOzp0It3d8cnyyVrifLq8+iosv/d3Aw6B2UqSSu1k2MARfpil3BKhPUZpM5XPBKWZwOoH8EA7MCtyjQmRI3ysUBZMhG4yCJVwLGJQOOZh87A9C4LhESqnXZtrPK89/W9nqklf88BVfZ6Ib+XTuVoVUTHWxyhZNxd5sJ0/w97M1i6yfctFj7WIxlo5+t8VyycMQtVwow8fKDHWCBSQz7jpRQ3c0ZxOiMUcDRsjiRR16pG3iY2qOKy5SJstnZYdrvPTl8/WAy6v5+IRo8horZ9ym4O958hd+8WKq1UeKML5ICvQhNZgSMlEv//wD0LjJow==
|
|
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 ask security question action' (create-ask-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 ask security question action</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/workflow_actions/ask_security_question_actions"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Create an ask 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 answer some personal security questions."}}></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><SchemaItem collapsible={false} name={"token_expiration"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","required":true,"description":"The token expiration time, coordinates with token_expiration_type.","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"token_expiration_type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`hours`, `days`, `login attempts`, `always`]"} schema={{"type":"string","required":true,"enum":["hours","days","login attempts","always"],"description":"The token expiration type, coordinates with token_expiration.","example":"days"}}></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> |