Qodex.ai

Create Registration Flow with Input Schema

POST {{authPath}}/{{envID}}/davinci/policy/{{davinciFlowPolicyID}}/start

The following sample shows the start flow endpoint, POST {{authPath}}/{{envID}}/davinci/policy/{{davinciFlowPolicyID}}/start, which initates the flow policy specified by the {{davinciFlowPolicyID}} in the request URL. In this case, the flow policy ID corresponds to a registration flow included in the policy that prompts the user to provide the required information to create a new account.

Note: Before you use this endpoint, see Initiating Flow Policies to determine if the /start endpoint on the {{authPath}} resource server is the best option for your flow.

The request body specifies the username, password, email, primaryPhone, name.family, and name.given input schema properties used in the flow. By adding these properties to the request, the start flow endpoint performs data validation on the request body values. For more information about using input schemas in a /start request, see Using an input schema with the flow.

Prerequisites

Request Body

{"email"=>"elmerfudd@pingidentity.com", "name"=>{"given"=>"Elmer", "family"=>"Fudd"}, "username"=>"elmerfudd", "primaryPhone"=>"+14155552672", "password"=>"{{password}}"}

RESPONSES

status: OK

{"id":"howu8n9hsc","companyId":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6","flowId":"3e0603680cbde668577a5eacc6c22987","connectionId":"867ed4363b2bc21c860085ad2baa817d","capabilityName":"customHTMLTemplate","screen":{"name":"HTTP","properties":{"sktemplate":{"type":"string","displayName":"Template","createdDate":1657665418265,"customerId":"ecb9bf8a2fab854e65045d02cb6bab50","companyId":"singularkey"},"customHTML":{"type":"string","displayName":"HTML Template","createdDate":1657665418205,"customerId":"ecb9bf8a2fab854e65045d02cb6bab50","companyId":"singularkey","preferredControlType":"textArea","enableParameters":true,"maximizeToggle":true,"viewToggle":true,"largePayload":true,"value":"\u003cdiv class=\"app-container\" style=\"display: block;\"\u003e\n\t\u003cdiv class=\"page__content\" style=\"height: 100%;\"\u003e\n\t\t\u003cdiv class=\"card card--no-padding\"\u003e\n\t\t\t\u003cdiv class=\"card__content\"\u003e\n\t\t\t\t\u003cdiv class=\"org-logo\"\u003e\n\t\t\t\t\t\u003cimg class=\"org-logo__image\" src=\"https://d3uinntk0mqu3p.cloudfront.net/branding/market/a3d073bc-3108-49ad-b96c-404bea59a1d0.png\" alt=\"Company Logo\" /\u003e\n\t\t\t\t\u003c/div\u003e\n\t\t\t\t\u003cdiv data-skcomponent=\"skerror\" class=\"feedback feedback--error sk-alert sk-alert-danger has-text-danger has-background-danger-light\" data-id=\"feedback\" data-skvisibility=\"\"\u003e\u003c/div\u003e\n\t\t\t\t\u003cform class=\"form\" id='usernamePasswordForm' data-id=\"usernamePasswordForm\"\u003e\n\t\t\t\t\t\u003cdiv class=\"field float-label\"\u003e\n\t\t\t\t\t\t\u003cinput class=\"text-input float-label__input\" data-id=\"username-input\" id=\"username\" name=\"username\" type=\"text\" autocomplete=\"on\" value=\"\" /\u003e\n\t\t\t\t\t\t\u003clabel class=\"float-label__label\" for=\"username\"\u003eUsername\u003c/label\u003e\n\t\t\t\t\t\u003c/div\u003e\n\t\t\t\t\t\u003cdiv class=\"field float-label\"\u003e\n\t\t\t\t\t\t\u003cinput class=\"text-input text-input--pasword float-label__input\" data-id=\"password-input\" id=\"password\" name=\"password\" type=\"password\" autocomplete=\"on\" value=\"\" /\u003e\n\t\t\t\t\t\t\u003clabel class=\"float-label__label\" for=\"password\"\u003ePassword\u003c/label\u003e\n\t\t\t\t\t\u003c/div\u003e\n\t\t\t\t\t\u003cdiv class=\"control\"\u003e\n\t\t\t\t\t\t\u003cbutton class=\"field is-primary mt-2 button file-input--button button--primary brand-primary-bg\" data-id=\"button\" type=\"submit\" data-skcomponent=\"skbutton\" data-skbuttontype=\"form-submit\" data-skform=\"usernamePasswordForm\" data-skbuttonvalue=\"submit\"\u003e\n                            Sign On\n\t\t\t\t\t\t\t\u003ci class=\"fas fa-forward ml-2\"\u003e\u003c/i\u003e\n\t\t\t\t\t\t\u003c/button\u003e\n\t\t\t\t\t\u003c/div\u003e\n\t\t\t\t\t\u003cdiv class=\"control\"\u003e\n                        \u003cdiv style=\"width: 100%; text-align: center;\"\u003e\n                            \u003cbutton type=\"submit\" class=\"buttonLink is-primary is-inverted mt-2\" data-skcomponent=\"skbutton\" data-skbuttontype=\"form-submit\" data-skform=\"usernamePasswordForm\" data-skbuttonvalue=\"forgotPassword\"\u003e\n                                Forgot Password\n                                \u003ci class=\"fas fa-forward ml-2\"\u003e\u003c/i\u003e\n                            \u003c/button\u003e\n                        \u003c/div\u003e\n\t\t\t\t\t\u003c/div\u003e\n\t\t\t\t\u003c/form\u003e\n\t\t\t\u003c/div\u003e\n\t\t\u003c/div\u003e\n\t\u003c/div\u003e\n\u003c/div\u003e\n"},"validationRules":{"type":"object","displayName":"Form validation rules","value":[],"info":"Rules to check to validate form inputs","createdDate":1657665418203,"customerId":"ecb9bf8a2fab854e65045d02cb6bab50","companyId":"singularkey","preferredControlType":"validationRules"},"customCSS":{"type":"string","displayName":"CSS","createdDate":1657665418313,"customerId":"ecb9bf8a2fab854e65045d02cb6bab50","companyId":"singularkey","preferredControlType":"codeEditor","language":"css","maximizeToggle":true,"largePayload":true},"customScript":{"type":"string","displayName":"Script","createdDate":1657665418314,"customerId":"ecb9bf8a2fab854e65045d02cb6bab50","companyId":"singularkey","preferredControlType":"codeEditor","value":"","language":"javascript","maximizeToggle":true},"inputSchema":{"type":"string","displayName":"Input Schema","createdDate":1657665418286,"customerId":"ecb9bf8a2fab854e65045d02cb6bab50","companyId":"singularkey","preferredControlType":"codeEditor","language":"json","info":"Follow example for JSON schema.","maximizeToggle":true},"outputSchema":{"type":"string","displayName":"Output Schema","createdDate":1657665418168,"customerId":"ecb9bf8a2fab854e65045d02cb6bab50","companyId":"singularkey","preferredControlType":"codeEditor","language":"json","info":"Follow example for JSON schema.","maximizeToggle":true},"formFieldsList":{"type":"array","constructType":"formFieldsList","displayName":"Output Fields List","createdDate":1657665418278,"customerId":"ecb9bf8a2fab854e65045d02cb6bab50","companyId":"singularkey","preferredControlType":"formFieldsList","hideLabel":false,"value":[{"preferredControlType":"textField","preferredDataType":"string","propertyName":"username","displayName":"Username","hashedVisibility":false},{"preferredControlType":"textField","preferredDataType":"string","propertyName":"password","displayName":"Password","hashedVisibility":true},{"preferredControlType":"textField","preferredDataType":"string","propertyName":"buttonValue"}]},"challenge":{"type":"string","displayName":"Challenge","createdDate":1657665418279,"customerId":"ecb9bf8a2fab854e65045d02cb6bab50","companyId":"singularkey","preferredControlType":"textField","enableParameters":true},"button":{"constructType":"button","displayName":"Submit","createdDate":1657665418275,"customerId":"ecb9bf8a2fab854e65045d02cb6bab50","companyId":"singularkey","logo":"","showLogo":true,"preferredControlType":"button","css":{"backgroundColor":"#1CAB42","color":"#ffffff"},"onClick":{"constructType":"skEvent","eventName":"continue","params":[],"eventType":"post","postProcess":{}}},"nodeTitle":{"value":"Username/Password Form"}},"userViews":[{"screenTemplateName":"CustomHTMLTemplate","items":[{"propertyName":"sktemplate"},{"propertyName":"customHTML"},{"propertyName":"validationRules"},{"propertyName":"customCSS"},{"propertyName":"customScript"},{"propertyName":"inputSchema"},{"propertyName":"outputSchema"},{"propertyName":"formFieldsList"},{"propertyName":"challenge"},{"propertyName":"button"}]}],"metadata":{"colors":{"canvas":"#AFD5FF","canvasText":"#253746","dark":"#2E5EA6"},"logos":{"canvas":{"imageFileName":"http.svg"}}}},"interactionId":"03b9c80f-0f33-4cc7-bd69-e4b2333db89c","interactionToken":"49da59305bec66faeafee2947ca0aabb99fc130cfa4ee051a4f1c417c236edabb1bbc3a3065d0eb8b5af853e4ffda70a42d6b8f493d5e72ea166d4d04ea8b06116aae8b228666809d172249cd265092c58682f7d349169ff9371e20798590ce55e221ba2f1be51e625741f1caf19767e221b692c5984267f14d5a05fe82e067e","skProxyApiEnvironmentId":"us-west-2"}