PingOne Platform APIs

DaVinci Admin Connectors

The PingOne DaVinci Admin Connector service provides endpoints to read DaVinci connector resources. Connectors give DaVinci the ability to integrate third party technologies, HTML pages, and other tools to create a sign-on flow. They define the capabilities that you can use as nodes in a flow. For example, an HTTP connector provides the capability to present an HTML form to collect and submit user information or make REST API calls.

It is recommended that you review the Using connectors securely topic in the PingOne DaVinci admin guide before assigning connectors to your workflow.

DaVinci admin connector data model properties

Property Type? Required? Mutable? Description

description

String

Optional

Mutable

The connector 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 connector ID (for example, httpConnector).

metadata

Object

N/A

Read only

Represents the metadata information about the connector, such as type, color, and logo.

metadata.type

String

N/A

Read only

The type of connector. Options are core, ping, or service.

metadata.vendor

String

N/A

Read only

The ID of a vendor (for example,microsoft or amazon).

metadata.colors

Object

N/A

Read only

An object that specifies the colors on the canvas.

metadata.colors.canvas

String

N/A

Read only

A hexadecimal representation of the canvas color.

metadata.colors.canvasText

String

N/A

Read only

A hexadecimal representation of the canvas text color.

metadata.colors.dark

String

N/A

Read only

A hexadecimal representation of the shade of darkness.

metadata.logos

String

N/A

Read only

The image name of the connector logo file.

metadata.logos.canvas

Object

N/A

Read only

An object that specifies the canvas.

metadata.logos.imageFileName

String

N/A

Read only

The name of the connector logo image.

name

String

Required

Mutable

The connector name (for example, HTTP).

version

String

N/A

Read only

The version number of the connector.

DaVinci admin connectors details data model properties

Property Type? Required? Mutable? Description

accountConfigView

Object[]

Optional

Mutable

Represents the account configuration of the connector. For details, refer to Core connectors.

accountConfigView.componentViewSize

String

Optional

Mutable

The size of the configuration window.

accountConfigView.items

Array

Optional

Mutable

An array of configurable properties.

accountConfigView.items.propertyName

String

Optional

Mutable

The name of the configurable property.

accountConfigView.items.items

Array

Optional

Mutable

An array of sub-property names under the top level property.

accountConfigView.items.items.propertyName

Array

Optional

Mutable

The name of the sub-property under the top level property.

capabilities

Object[]

Optional

Mutable

A list of all connector capabilities and their input properties. For more information, refer to Core connectors.

createdAt

Date

N/A

Read only

The time when the connector was created.

credentialsView

Object

Optional

Mutable

Represents the credentials view of the connector.

credentialsView

Object

Optional

Mutable

The fields that will be part of the connector configuration specific to credentials.

credentialsView.items

Array

Optional

Mutable

An array of configurable properties.

credentialsView.items.propertyName

String

Optional

Mutable

The name of the property.

flowSections

Object[]

Optional

Mutable

Represents the flow section to which the connector can be categorized.

flowSections.name

String

Optional

Mutable

The name of the section being shown.

flowSections.value

String

Optional

Mutable

A pointer to the flow section name referenced by other sections in the manifest.

properties

Object

Optional

Mutable

A list of properties that will be used by the capabilities. For more information, refer to Core connectors.

sections

Object[]

Optional

Mutable

An array of sections shown in Connector Configuration. For more information, refer to Core connectors.

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.