mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
45 lines
9.4 KiB
Plaintext
45 lines
9.4 KiB
Plaintext
---
|
|
id: create-form
|
|
sidebar_label: Create a form
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztVm1v0zAQ/iuWP/eNsRVUiQ8DhlQkGNoKX6BCl+TSGhI72E67qOp/585e2qwtAz5DK7WJ77k333Nnb2SGLrWq8spoOZGzpXICdVYZpb1IQYvUIngUIHJjS9mTpkILjJ5mhI/SN1HkYeHk5LNkpJPznrT4o0bnX5qskZNNeFUWSc/bGnsyNdqj9iyCqipUGuwOvzkOZSNdusQS+Mk3FZIzk3zD1JOjynIUXqFjaQjst6haZR2Q81bpBYEO00dBQGFy4enxPmW8g7IqWI0XvrKl7YHmzrDHO/9AhfeGDcWNJKdC41pQbLki+akAOisPAiGfGko8lcXe3btGBI/vGXnKOps4NAs2XaoVdjcoMaZA0F3bORQOD02+Ro+2VBqdWC+RjNqdZUFU2lnekhuv/G5LHK3wh0niKqNdrNLZaMR/D31c3VVUUcxECxXeECFXUCheCxyT/+n0T9GpJ08XgJFAHJA17yuzC7JrXTTtzDnO4JH6nOFonDx/Nu7n5xfj/vmzp1k/ycYX/WR8/vQCR8k4OTvB7P7Zjtvnp+j8EjJxE1kr+qLWkBSB0alhtx4Hf8Nlo/E6p6F7zNc2pqkOjfKWVbe9X+M+MSq4ubLWWGrQeUzi4lQSU4rPaijELdoVVSnoUDoWfW019SqxrdZL0FlBL3iXYtB0f5Xc4y2I7PI4sktRonOwaJmfcJNweSO+W99bY20jnCmJaYxaU1RibQ0xaduWkGWGj7rKhClTgV/S2zAecj3pQv4ulKC2BYmW3lduMhxuKEnQnltnO9BUKPJqGsQBFXoIlSLlFVjF5Q/57OExqRzqgpkMaYmpOe6+AI8NCM6pBe8606h2njKynMKc40trq3wTAkwQLNrLmlP4PO+Kb3nTYxxd0K4GnBRnG2Dc0AFEK/HhTdt2M/MdNYVBvy8aU9v4GJqE63uzvxFctWXYj9wwVPdT8TDj382+OM4OZ9Z+GoWJw5EonRv2x4WLpp8MRoNRpxneX928E5cfpidnXisM96OERryLOw9pSswTxHlRmkzljeD6mtrxwUV7QVKhtAjbgnqliGglMY5bgpoA6WDjoNosprOwa0y7EnRH8urgRnZwcuy66w8uc51TZlgVoHhCRBZv7oneuc0tuQFoYbNJwOFHW2y3vEwFtcyu+Z7OgVykQLOXOMLE+44NRx5D68/YLcOLmt0fDQEeU1HjMuXB8Sh23unRD9e3M+bk/YWTqsA6FtZ8EtDvRH6hb7jFhmkUbqW8vpEF6EVNU4Mw0S5/fgJbWdc0
|
|
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 form' (create-form)"
|
|
---
|
|
|
|
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 form</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/forms"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This endpoint can create a form
|
|
|
|
## 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"}>form</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The uid of the form","example":"form_uid"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"text"} qualifierMessage={undefined} schema={{"type":"text","example":"Form for creating new profile","description":"The description of the form"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"My Form Name","description":"The name of the form"}}></SchemaItem><SchemaItem collapsible={false} name={"archived"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":false,"description":"Determines whether the form is archived"}}></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"}>form</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The uid of the form","example":"form_uid"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"text"} qualifierMessage={undefined} schema={{"type":"text","example":"Form for creating new profile","description":"The description of the form"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"My Form Name","description":"The name of the form"}}></SchemaItem><SchemaItem collapsible={false} name={"archived"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":false,"description":"Determines whether the form is archived"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","readOnly":true,"description":"The id of the form","example":"2e06b876-f456-473d-bd65-b6435e0b6b2d"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"form\": {\n \"uid\": \"form_uid\",\n \"description\": \"Form for creating new profile\",\n \"name\": \"My Form Name\",\n \"archived\": false,\n \"id\": \"2e06b876-f456-473d-bd65-b6435e0b6b2d\"\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> |