PUT /api/v1/meta/uischemas/{id}

Replaces a UI Schema by id

Servers

https://{yourOktaDomain}

Path parameters

Name	Type	Required	Description
`id`	String	Yes	The unique ID of the UI Schema

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`uiSchema`	Object	No	Properties of the UI schema
`uiSchema.label`	String	No	Specifies the label at the top of the enrollment form under the logo Default value: "Sign in"
`uiSchema.type`	String	No	Specifies the type of layout
`uiSchema.buttonLabel`	String	No	Specifies the button label for the `Submit` button at the bottom of the enrollment form Default value: "Submit"
`uiSchema.elements`	Object	No	Specifies the configuration of an input field on an enrollment form
`uiSchema.elements.options`	Object	No	UI Schema element options object
`uiSchema.elements.options.format`	String	No	Specifies how the input appears Possible values: `"text"` `"checkbox"` `"radio_true_false"` `"radio_yes_no"` `"radio"` `"select"`
`uiSchema.elements.label`	String	No	Label name for the UI element
`uiSchema.elements.type`	String	No	Specifies the relationship between this input element and `scope`. The `Control` value specifies that this input controls the value represented by `scope`.
`uiSchema.elements.scope`	String	No	Specifies the property bound to the input field. It must follow the format `#/properties/PROPERTY_NAME` where `PROPERTY_NAME` is a variable name for an attribute in `profile editor`.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.