PingOne Platform APIs

DaVinci Admin UI Templates

You can create user interface (UI) templates that match your company style and branding, which you can include in flows using an HTTP connector. The PingOne DaVinci Admin UI Templates service provides endpoints to create, read, and delete DaVinci UI templates.

DaVinci Admin UI templates data model properties

Property Type? Required? Mutable? Description

createdAt

Date

N/A

Read only

A UTC string that specifies the time when the DaVinci UI template was created.

description

String

Optional

Mutable

The UI template description.

environment

Object

N/A

Read only

The DaVinci company ID (environment ID) object.

environment.id

String

N/A

Read only

The DaVinci company ID, which is the PingOne environment ID.

id

String

N/A

Read only

The DaVinci UI template ID.

name

String

Required

Mutable

The UI template name.

inputSchema

String

Optional

Mutable

A JSON representation of the input schema defined in this template.

outputSchema

String

Optional

Mutable

A JSON representation of the output schema defined in this template.

script

String

Optional

Mutable

Javascript code utilized by this template.

style

String

Optional

Mutable

The CSS used in flows that are associated with this template.

template

String

Optional

Mutable

The HTML template to me rendered.

updatedAt

Date

N/A

Read only

A UTC string that specifies the time when the UI template was last modified.

validationRules

Array

Optional

Mutable

The validation rules object.

validationRules.propertyName

String

Required

Mutable

The name of the property to which the validation rule applies.

validationRules.rules

Array

Required

Mutable

The rules object in which the validation rules elements are defined.

validationRules.rules.ruleName

String

Required

Mutable

The name of the rule. Options are presence, email, length, format, and equality.

validationRules.rules.message

String

Optional

Mutable

The rule message that displays if the required property is not present or if the property is not a valid email. For length rules, enter a minimum, maximum, or exact value for the property and a validation message that is displayed for each length restriction that is not met. For format rules, enter the regex that defines the required format and the validation message that displays if the property does not match the format. For equality rules, enter the other property that this property must match, and the validation message that displays if the properties do not match.

validationRules.rules.attribute

String

Optional

Mutable

The property to check when applying the equality rule.

validationRules.rules.pattern

String

Optional

Mutable

The pattern to match when applying the format rule.

Response codes

Code Message

200

Successful operation.

201

Successfully created.

204

Successfully removed. No content.

400

The request could not be completed.

401

You do not have access to this resource.

403

You do not have permissions or are not licensed to make this request.

404

The requested resource was not found.