PingOne Platform APIs

DaVinci Admin Connector Instances

The PingOne DaVinci Admin Connector Instances service provides endpoints to create, read, update, and delete DaVinci connector instances. A DaVinci connector instance is one instance of a DaVinci connector (the connection configuration specifies a connector by name). You can then use the capabilities provided by the connector inside a flow, and launch the flow through an application.

This service also includes an action to clone connector instance resources.

Assigning admin roles and permissions to this service

Admin role assignments determine access to PingOne APIs. When assigning admin roles to this service, refer to PingOne Permissions by Service for the service-specific permissions.

You can also choose to assign admin roles based on particular service resources. Refer to PingOne Permissions by Resource when assigning admin roles per service resources.

Admin assignments to roles are set by:

Refer to Roles Management for more information.

DaVinci admin connector instances data model properties

Property Type Required Mutable Description

connector

Object

Required

Immutable

The connector object.

connector.id

String

Required

Immutable

The connector object name (for example, httpConnector).

createdAt

Date

N/A

Read only

The time when the connection was created.

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 instance resource ID.

name

String

Required

Mutable

The connector instance name.

properties

Object

Optional

Mutable

The configuration of the connector object. This field is not applicable to all connectors and is omitted in the output if empty or null. If the specified connector requires configuration, refer to the Connector configuration section of the connector documentation for the connector specified in connector.id.

updatedAt

Date

N/A

Read only

The time when the connector instance was updated.

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.

DaVinci connector instance errors

In addition to the general error codes, DaVinci connector instance operations can return the following errors:

HTTP status Top‑level code Detail code When it happens and what the response contains

400

INVALID_DATA

REQUIRED_VALUE, EMPTY_VALUE, INVALID_VALUE, or OUT_OF_RANGE

Message: The request could not be completed. One or more validation errors were in the request.

When and details

When: A POST /environments/{envID}/connectorInstances or a PUT /environments/{envID}/connectorInstances/{connectorInstanceID} request supplies a body that violates the data model: an omitted name property, an omitted connector object or an omitted connector.id property on create, an empty or blank name, a name or connector.id value longer than 256 characters, a name or connector.id value that starts with an unsupported character or contains a < or a ${ sequence, or a property whose value is not of the documented JSON type

Details: One detail per validation error, each with the failing property path as the target. must have required property 'name' with target name and must have required property 'connector' with target connector when the create request omits either property, and must have required property 'id' with target connector when the connector object omits id. must not be empty or blank for an empty or blank name. must NOT have more than 256 characters for a name or connector.id value longer than 256 characters. must match pattern "<pattern>", where <pattern> is the schema pattern, for a name or connector.id value that starts with an unsupported character or contains a < or a ${ sequence. must be string for a property of the wrong JSON type, for example with target name.

400

INVALID_DATA

INVALID_PARAMETER

Message: The request could not be completed. One or more validation errors were in the request.

When and details

When: A GET /environments/{envID}/connectorInstances or a GET /environments/{envID}/connectorInstances/{connectorInstanceID} request supplies a page, limit, expand, or filter query parameter longer than 256 characters

Details: Detail code INVALID_PARAMETER with message must NOT have more than 256 characters and the overlong query parameter as the target.

400

INVALID_DATA

INVALID_VALUE

Message: The request could not be completed. One or more validation errors were in the request.

When and details

When: A POST /environments/{envID}/connectorInstances request specifies a connector.id value that does not identify a connector available to the environment

Details: Detail code INVALID_VALUE with message Invalid connector id and no target.

400

INVALID_DATA

UNIQUENESS_VIOLATION

Message: The request could not be completed. One or more validation errors were in the request.

When and details

When: A POST /environments/{envID}/connectorInstances or a POST /environments/{envID}/connectorInstances/{connectorInstanceID} clone request uses a name that is already associated with a connector instance in the environment

Details: Detail code UNIQUENESS_VIOLATION with message The connector name entered is already associated with another connector. Enter a different name. and no target.

400

INVALID_DATA

UNIQUENESS_VIOLATION

Message: The request could not be completed. One or more validation errors were in the request.

When and details

When: A PUT /environments/{envID}/connectorInstances/{connectorInstanceID} request renames the connector instance to a name that another connector instance in the environment already uses

Details: Detail code UNIQUENESS_VIOLATION with message A resource with the specified name already exists and target name.

400

REQUEST_FAILED

INVALID_PARAMETER or INVALID_FILTER

Message: The request could not be completed. There was an issue processing the request.

When and details

When: A GET /environments/{envID}/connectorInstances request supplies a filter query parameter that references any attribute other than the six actor identifier attributes createdBy.user.id, createdBy.client.id, createdBy.environment.id, updatedBy.user.id, updatedBy.client.id, or updatedBy.environment.id when actor metadata is enabled for the environment, or supplies any filter query parameter when actor metadata is disabled. When actor metadata is enabled, actor attributes support only eq combined through and or or

Details: Detail code INVALID_PARAMETER with message The filter attribute was invalid or does not support filtering. and the invalid attribute as the target, or message The filter operator was invalid or not supported. and the attribute that does not support the supplied operator as the target. A filter that is not a well-formed SCIM expression returns detail code INVALID_FILTER with message The specified filter was invalid. and no target.

403

ACCESS_FAILED

None

Message: The request could not be completed. You do not have access to this resource.

When and details

When: The actor lacks the davinci:create:connections permission (POST operations), the davinci:read:connections permission (GET operations), the davinci:update:connections permission (PUT operations), or the davinci:delete:connections permission (DELETE operations)

Details: None

404

NOT_FOUND

None

Message: The request could not be completed. The requested resource was not found.

When and details

When: A GET, PUT, or DELETE request references a connector instance ID that does not exist in the environment, or a POST clone request references a source connector instance ID that does not exist or could not be read

Details: None

415

INVALID_REQUEST

None

Message:

The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method.
When and details

When: A POST /environments/{envID}/connectorInstances/{connectorInstanceID} clone request does not set the Content-Type header to application/vnd.pingidentity.connectorInstance.clone+json

Details: None