Ping Identity DaVinci Admin Connectors API
Operations for managing DaVinci connectors and connector instances
Operations for managing DaVinci connectors and connector instances
openapi: 3.1.1
info:
title: PingOne Platform Configuration Management DaVinci Admin Connectors API
version: 2026.01.07-beta
description: PingOne is a cloud-based framework for secure identity access management. The PingOne API gives developers the tools to integrate enterprise and third-party applications with the PingOne platform.
contact:
name: Ping Identity Developer Experiences
url: https://developer.pingidentity.com
email: devex@pingidentity.com
license:
identifier: Apache-2.0
name: Apache 2.0
servers:
- url: https://api.pingone.{tld}/{basePath}
variables:
basePath:
default: v1
tld:
enum:
- eu
- com
- asia
- com.au
- ca
- sg
default: com
security:
- bearerAuth: []
- oauth2: []
tags:
- name: DaVinci Admin Connectors
description: Operations for managing DaVinci connectors and connector instances
paths:
/environments/{environmentID}/connectors:
get:
operationId: getConnectors
parameters:
- $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
- $ref: '#/components/parameters/com.pingidentity.header.ExternalSessionID'
- $ref: '#/components/parameters/com.pingidentity.header.ExternalTransactionID'
responses:
'200':
description: Successful Operation.
content:
application/json:
schema:
$ref: '#/components/schemas/com.pingidentity.pingone.davinci.connectors.response.ConnectorsMinimalResponse'
'400':
$ref: '#/components/responses/http.400.BadRequest'
'401':
$ref: '#/components/responses/http.401.Unauthorized'
'403':
$ref: '#/components/responses/http.403.Forbidden.P14C63085.DOCS8830'
'404':
$ref: '#/components/responses/http.404.NotFound.DOCS8830'
'415':
$ref: '#/components/responses/http.415.UnsupportedMediaType'
'429':
$ref: '#/components/responses/http.429.TooManyRequests'
'500':
$ref: '#/components/responses/http.500.InternalServerError'
'502':
$ref: '#/components/responses/http.502.BadGateway'
'503':
$ref: '#/components/responses/http.503.ServiceUnavailable'
x-permission: davinci:read:connectors
tags:
- DaVinci Admin Connectors
/environments/{environmentID}/connectors/{connectorID}:
get:
operationId: getConnectorById
parameters:
- $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
- $ref: '#/components/parameters/com.pingidentity.path.environments.connectors.connectorID'
- $ref: '#/components/parameters/com.pingidentity.header.ExternalSessionID'
- $ref: '#/components/parameters/com.pingidentity.header.ExternalTransactionID'
responses:
'200':
description: Successful Operation.
content:
application/json:
schema:
$ref: '#/components/schemas/com.pingidentity.pingone.davinci.connectors.response.ConnectorMinimalResponse'
'400':
$ref: '#/components/responses/http.400.BadRequest'
'401':
$ref: '#/components/responses/http.401.Unauthorized'
'403':
$ref: '#/components/responses/http.403.Forbidden.P14C63085.DOCS8830'
'404':
$ref: '#/components/responses/http.404.NotFound.DOCS8830'
'415':
$ref: '#/components/responses/http.415.UnsupportedMediaType'
'429':
$ref: '#/components/responses/http.429.TooManyRequests'
'500':
$ref: '#/components/responses/http.500.InternalServerError'
'502':
$ref: '#/components/responses/http.502.BadGateway'
'503':
$ref: '#/components/responses/http.503.ServiceUnavailable'
x-permission: davinci:read:connectors
tags:
- DaVinci Admin Connectors
/environments/{environmentID}/connectors/{connectorID}/details:
get:
operationId: getDetailsByConnectorId
parameters:
- $ref: '#/components/parameters/com.pingidentity.path.environments.environmentID'
- $ref: '#/components/parameters/com.pingidentity.path.environments.connectors.connectorID'
- $ref: '#/components/parameters/com.pingidentity.header.ExternalSessionID'
- $ref: '#/components/parameters/com.pingidentity.header.ExternalTransactionID'
responses:
'200':
description: Successful Operation.
content:
application/json:
schema:
$ref: '#/components/schemas/com.pingidentity.pingone.davinci.connectors.response.ConnectorDetailsResponse'
'400':
$ref: '#/components/responses/http.400.BadRequest'
'401':
$ref: '#/components/responses/http.401.Unauthorized'
'403':
$ref: '#/components/responses/http.403.Forbidden.P14C63085'
'404':
$ref: '#/components/responses/http.404.NotFound'
'415':
$ref: '#/components/responses/http.415.UnsupportedMediaType'
'429':
$ref: '#/components/responses/http.429.TooManyRequests'
'500':
$ref: '#/components/responses/http.500.InternalServerError'
'502':
$ref: '#/components/responses/http.502.BadGateway'
'503':
$ref: '#/components/responses/http.503.ServiceUnavailable'
x-permission: davinci:read:connectors
tags:
- DaVinci Admin Connectors
components:
schemas:
com.pingidentity.pingone.davinci.connectors.response.ConnectorMinimalResponse:
type: object
properties:
_links:
type: object
properties:
environment:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
self:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
required:
- environment
- self
additionalProperties:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
title: DaVinci Connector Minimal Response _links
createdAt:
type: string
format: date-time
minLength: 1
title: DaVinci Connector Minimal Response Created At
environment:
$ref: '#/components/schemas/com.pingidentity.api.Relationship.PingOne.RO'
id:
type: string
minLength: 1
title: DaVinci Connector Minimal Response Id
metadata:
type: object
properties:
colors:
type: object
properties:
canvas:
type: string
title: DaVinci Connector Minimal Response Metadata Colors Canvas
canvasText:
type: string
title: DaVinci Connector Minimal Response Metadata Colors Canvas Text
dark:
type: string
title: DaVinci Connector Minimal Response Metadata Colors Dark
title: DaVinci Connector Minimal Response Metadata Colors
logos:
type: object
properties:
canvas:
type: object
properties:
imageFileName:
type: string
title: DaVinci Connector Minimal Response Metadata Logos Canvas Image File Name
title: DaVinci Connector Minimal Response Metadata Logos Canvas
title: DaVinci Connector Minimal Response Metadata Logos
type:
enum:
- core
- ping
- service
type: string
title: DaVinci Connector Minimal Response Metadata Type
vendor:
type: string
title: DaVinci Connector Minimal Response Metadata Vendor
title: DaVinci Connector Minimal Response Metadata
name:
type: string
minLength: 1
title: DaVinci Connector Minimal Response Name
version:
type: string
minLength: 1
title: DaVinci Connector Minimal Response Version
description:
type: string
title: DaVinci Connector Minimal Response Description
updatedAt:
type: string
format: date-time
title: DaVinci Connector Minimal Response Updated At
required:
- _links
- createdAt
- environment
- id
- metadata
- name
- version
title: DaVinci Connector Minimal Response
com.pingidentity.ApiErrorResponse:
type: object
properties:
code:
type: string
title: General Error Code
details:
type: array
items:
$ref: '#/components/schemas/com.pingidentity.ErrorDetail'
title: General Error Details
id:
type: string
title: General Error Id
message:
type: string
title: General Error Message
title: General Error
com.pingidentity.ApiErrorResponse.400:
$schema: http://json-schema.org/draft/2020-12/schema#
type: object
properties:
id:
type: string
format: uuid
minLength: 1
title: Bad Request Error Id
code:
type: string
enum:
- INVALID_DATA
- INVALID_REQUEST
- REQUEST_FAILED
minLength: 1
title: Bad Request Error Code
message:
type: string
minLength: 1
title: Bad Request Error Message
details:
type: array
items:
type: object
properties:
code:
type: string
enum:
- ACCOUNT_NOT_USABLE
- CONSTRAINT_VIOLATION
- EMPTY_VALUE
- INVALID_FILTER
- INVALID_OTP
- INVALID_PARAMETER
- INVALID_VALUE
- MFA_AUTH_METHODS_CONFLICT
- NO_PASSWORD
- OUT_OF_RANGE
- REQUIRED_VALUE
- SIZE_LIMIT_EXCEEDED
- UNIQUENESS_VIOLATION
minLength: 1
title: Bad Request Error Detail Code
message:
type: string
minLength: 1
title: Bad Request Error Detail Message
innerError:
type: object
properties:
allowedPattern:
type: string
title: Bad Request Error Detail Inner Error Allowed Pattern
allowedValues:
type: array
items:
type: string
title: Bad Request Error Detail Inner Error Allowed Value
title: Bad Request Error Detail Inner Error Allowed Values
claim:
type: string
title: Bad Request Error Detail Inner Error Claim
existingId:
type: string
format: uuid
title: Bad Request Error Detail Inner Error Existing Id
maximumValue:
type: number
title: Bad Request Error Detail Inner Error Maximum Value
quotaLimit:
type: number
title: Bad Request Error Detail Inner Error Quota Limit
quotaResetTime:
type: string
format: date-time
title: Bad Request Error Detail Inner Error Quota Reset Time
rangeMaximumValue:
type: number
title: Bad Request Error Detail Inner Error Range Maximum Value
rangeMinimumValue:
type: number
title: Bad Request Error Detail Inner Error Range Minimum Value
supportedAttributes:
type: array
items:
type: string
title: Bad Request Error Detail Inner Error Supported Attribute
title: Bad Request Error Detail Inner Error Supported Attributes
supportedOperators:
type: array
items:
type: string
title: Bad Request Error Detail Inner Error Supported Operator
title: Bad Request Error Detail Inner Error Supported Operators
additionalProperties: true
title: Bad Request Error Detail Inner Error
target:
type: string
title: Bad Request Error Detail Target
required:
- code
- message
title: Bad Request Error Detail
title: Bad Request Error Details
required:
- id
- code
- message
title: Bad Request Error
com.pingidentity.ErrorDetail:
type: object
properties:
code:
type: string
title: General Error Detail Code
innerError:
type: object
additionalProperties:
type: object
title: General Error Detail Inner Error Additional Properties
title: General Error Detail Inner Error
message:
type: string
title: General Error Detail Message
target:
type: string
title: General Error Detail Target
title: General Error Detail
com.pingidentity.ApiErrorResponse.403:
$schema: http://json-schema.org/draft/2020-12/schema#
type: object
properties:
code:
type: string
enum:
- ACCESS_FAILED
minLength: 1
title: Forbidden Error Code
message:
type: string
minLength: 1
title: Forbidden Error Message
details:
type: array
items:
type: object
properties:
code:
type: string
enum:
- INSUFFICIENT_PERMISSIONS
- LICENSE_EXCEEDED
minLength: 1
title: Forbidden Error Detail Code
message:
type: string
minLength: 1
title: Forbidden Error Detail Message
innerError:
type: object
properties:
quotaLimit:
type: number
title: Forbidden Error Detail Inner Error Quota Limit
additionalProperties: true
title: Forbidden Error Detail Inner Error
target:
type: string
title: Forbidden Error Detail Target
required:
- code
- message
title: Forbidden Error Detail
title: Forbidden Error Details
id:
type: string
format: uuid
title: Forbidden Error Id
required:
- code
- message
title: Forbidden Error
com.pingidentity.ApiErrorResponse.404:
$schema: http://json-schema.org/draft/2020-12/schema#
type: object
properties:
id:
type: string
format: uuid
minLength: 1
title: Not Found Error Id
code:
type: string
enum:
- NOT_FOUND
minLength: 1
title: Not Found Error Code
message:
type: string
minLength: 1
title: Not Found Error Message
details:
type: array
items:
type: object
properties:
code:
type: string
minLength: 1
title: Not Found Error Detail Code
message:
type: string
minLength: 1
title: Not Found Error Detail Message
innerError:
type: object
additionalProperties: true
title: Not Found Error Detail Inner Error
target:
type: string
title: Not Found Error Detail Target
required:
- code
- message
title: Not Found Error Detail
title: Not Found Error Details
required:
- id
- code
- message
title: Not Found Error
com.pingidentity.api.response.Link:
type: object
properties:
href:
type: string
format: uri
minLength: 1
title: JSON HAL Link Href
name:
type: string
title: JSON HAL Link Name
profile:
type: string
format: uri
title: JSON HAL Link Profile
title:
type: string
format: uri
title: JSON HAL Link Title
type:
type: string
title: JSON HAL Link Type
required:
- href
readOnly: true
title: JSON HAL Link
com.pingidentity.api.Relationship.PingOne.RO:
type: object
properties:
id:
type: string
format: uuid
readOnly: true
minLength: 1
title: Resource Relationship Read-Only Id
required:
- id
title: Resource Relationship Read-Only
com.pingidentity.ApiErrorResponse.415:
$schema: http://json-schema.org/draft/2020-12/schema#
type: object
properties:
id:
type: string
format: uuid
minLength: 1
title: Unsupported Media Type Error Id
code:
type: string
enum:
- INVALID_REQUEST
minLength: 1
title: Unsupported Media Type Error Code
message:
type: string
minLength: 1
title: Unsupported Media Type Error Message
details:
type: array
items:
type: object
properties:
code:
type: string
minLength: 1
title: Unsupported Media Type Error Detail Code
message:
type: string
minLength: 1
title: Unsupported Media Type Error Detail Message
innerError:
type: object
additionalProperties: true
title: Unsupported Media Type Error Detail Inner Error
target:
type: string
title: Unsupported Media Type Error Detail Target
required:
- code
- message
title: Unsupported Media Type Error Detail
title: Unsupported Media Type Error Details
required:
- id
- code
- message
title: Unsupported Media Type Error
com.pingidentity.ApiErrorResponse.500:
$schema: http://json-schema.org/draft/2020-12/schema#
type: object
properties:
id:
type: string
format: uuid
minLength: 1
title: Internal Server Error Id
code:
type: string
enum:
- UNEXPECTED_ERROR
minLength: 1
title: Internal Server Error Code
message:
type: string
minLength: 1
title: Internal Server Error Message
details:
type: array
items:
type: object
properties:
code:
type: string
minLength: 1
title: Internal Server Error Detail Code
message:
type: string
minLength: 1
title: Internal Server Error Detail Message
innerError:
type: object
additionalProperties: true
title: Internal Server Error Detail Inner Error
target:
type: string
title: Internal Server Error Detail Target
required:
- code
- message
title: Internal Server Error Detail
title: Internal Server Error Details
required:
- id
- code
- message
title: Internal Server Error
com.pingidentity.ApiErrorResponse.401:
$schema: http://json-schema.org/draft/2020-12/schema#
type: object
properties:
id:
type: string
format: uuid
minLength: 1
title: Unauthorized Error Id
code:
type: string
enum:
- ACCESS_FAILED
minLength: 1
title: Unauthorized Error Code
message:
type: string
minLength: 1
title: Unauthorized Error Message
details:
type: array
items:
type: object
properties:
code:
type: string
enum:
- INSUFFICIENT_PERMISSIONS
- INVALID_TOKEN
minLength: 1
title: Unauthorized Error Detail Code
message:
type: string
minLength: 1
title: Unauthorized Error Detail Message
innerError:
type: object
additionalProperties: true
title: Unauthorized Error Detail Inner Error
target:
type: string
title: Unauthorized Error Detail Target
required:
- code
- message
title: Unauthorized Error Detail
title: Unauthorized Error Details
required:
- id
- code
- message
title: Unauthorized Error
com.pingidentity.pingone.davinci.connectors.response.ConnectorsMinimalResponse:
type: object
properties:
_embedded:
type: object
properties:
connectors:
type: array
items:
type: object
$ref: '#/components/schemas/com.pingidentity.pingone.davinci.connectors.response.ConnectorMinimalResponse'
title: DaVinci Connector Collection Minimal Response _embedded Connectors
required:
- connectors
title: DaVinci Connector Collection Minimal Response _embedded
_links:
type: object
properties:
environment:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
self:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
required:
- environment
- self
additionalProperties:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
title: DaVinci Connector Collection Minimal Response _links
required:
- _embedded
- _links
title: DaVinci Connector Collection Minimal Response
com.pingidentity.ApiErrorResponse.429:
$schema: http://json-schema.org/draft/2020-12/schema#
type: object
properties:
code:
type: string
enum:
- REQUEST_LIMITED
minLength: 1
title: Too Many Requests Error Code
message:
type: string
minLength: 1
title: Too Many Requests Error Message
details:
type: array
items:
type: object
properties:
code:
type: string
enum:
- LIMIT_EXCEEDED
- QUOTA_EXCEEDED
minLength: 1
title: Too Many Requests Error Detail Code
message:
type: string
minLength: 1
title: Too Many Requests Error Detail Message
innerError:
type: object
properties:
quotaLimit:
type: number
title: Too Many Requests Error Detail Inner Error Quota Limit
quotaResetTime:
type: string
format: date-time
title: Too Many Requests Error Detail Inner Error Quota Reset Time
retryAfter:
type: string
format: date-time
title: Too Many Requests Error Detail Inner Error Retry After
additionalProperties: true
title: Too Many Requests Error Detail Inner Error
target:
type: string
title: Too Many Requests Error Detail Target
required:
- code
- message
title: Too Many Requests Error Detail
title: Too Many Requests Error Details
id:
type: string
format: uuid
title: Too Many Requests Error Id
required:
- code
- message
title: Too Many Requests Error
com.pingidentity.pingone.davinci.connectors.response.ConnectorDetailsResponse:
type: object
properties:
environment:
$ref: '#/components/schemas/com.pingidentity.api.Relationship.PingOne.RO'
_links:
type: object
properties:
environment:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
self:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
required:
- environment
- self
additionalProperties:
$ref: '#/components/schemas/com.pingidentity.api.response.Link'
title: DaVinci Connector Details Response _links
accountConfigView:
type: object
properties:
items:
type: array
items:
type: object
properties: {}
additionalProperties: true
title: DaVinci Connector Details Response Account Config View Item Item
title: DaVinci Connector Details Response Account Config View Item
componentViewSize:
type: string
title: DaVinci Connector Details Response Account Config View Component View Size
required:
- items
title: DaVinci Connector Details Response Account Config View
capabilities:
type: object
additionalProperties:
type: object
additionalProperties: false
patternProperties:
^[0-9]+$:
type: object
additionalProperties: true
properties:
flowConfigView:
type: object
properties:
items:
type: array
items:
type: object
properties: {}
additionalProperties: true
title: DaVinci Connector Details Response Capabilities Additional Properties Pattern Properties `^[0-9]+$` Flow Config View Item Item
title: DaVinci Connector Details Response Capabilities Additional Properties Pattern Properties `^[0-9]+$` Flow Config View Item
required:
- items
title: DaVinci Connector Details Response Capabilities Additional Properties Pattern Properties `^[0-9]+$` Flow Config View
globalOutputSchema:
type: object
title: DaVinci Connector Details Response Capabilities Additional Properties Pattern Properties `^[0-9]+$` Global Output Schema
inputs:
type: array
items:
type: string
title: DaVinci Connector Details Response Capabilities Additional Properties Pattern Properties `^[0-9]+$` Input
title: DaVinci Connector Details Response Capabilities Additional Properties Pattern Properties `^[0-9]+$` Inputs
respondToUser:
type: boolean
title: DaVinci Connector Details Response Capabilities Additional Properties Pattern Properties `^[0-9]+$` Respond To User
subTitle:
type: string
title: DaVinci Connector Details Response Capabilities Additional Properties Pattern Properties `^[0-9]+$` Sub Title
title:
type: string
title: DaVinci Connector Details Response Capabilities Additional Properties Pattern Properties `^[0-9]+$` Title
type:
type: string
title: DaVinci Connector Details Response Capabilities Additional Properties Pattern Properties `^[0-9]+$` Type
userViews:
type: array
items:
type: object
title: DaVinci Connector Details Response Capabilities Additional Properties Pattern Properties `^[0-9]+$` User View
title: DaVinci Connector Details Response Capabilities Additional Properties Pattern Properties `^[0-9]+$` User Views
title: DaVinci Connector Details Response Capabilities Additional Properties Pattern Properties `^[0-9]+$`
title: DaVinci Connector Details Response Capabilities Additional Properties
title: DaVinci Connector Details Response Capabilities
credentialsView:
type: object
properties:
items:
type: array
items:
type: object
properties: {}
additionalProperties: true
title: DaVinci Connector Details Response Credentials View Item Item
title: DaVinci Connector Details Response Credentials View Item
required:
- items
title: DaVinci Connector Details Response Credentials View
flowSections:
type: array
items:
type: object
properties:
name:
type: string
minLength: 1
title: DaVinci Connector Details Response Flow Section Name
value:
type: string
minLength: 1
title: DaVinci Connector Details Response Flow Section Value
required:
- name
- value
title: DaVinci Connector Details Response Flow Section
title: DaVinci Connector Details Response Flow Sections
properties:
type: object
properties: {}
additionalProperties: true
title: DaVinci Connector Details Response Properties
sections:
type: array
items:
type: object
properties:
name:
type: string
minLength: 1
title: DaVinci Connector Details Response Section Name
value:
type: string
minLength: 1
title: DaVinci Connector Details Response Section Value
default:
type: boolean
title: DaVinci Connector Details Response Section Default
required:
- name
- value
title: DaVinci Connector Details Response Section
title: DaVinci Connector Details Response Sections
required:
- environment
title: DaVinci Connector Details Response
responses:
http.403.Forbidden.P14C63085:
description: 'Forbidden - Note: This may occur if the environment doesn''t exist. Check for environment existence with GET /environments/{environmentID} first.'
content:
'*/*':
schema:
$ref: '#/components/schemas/com.pingidentity.ApiErrorResponse.403'
x-pingone-p14c-63085: true
http.502.BadGateway:
description: Bad Gateway
content:
'*/*':
schema:
$ref: '#/components/schemas/com.pingidentity.ApiErrorResponse'
http.404.NotFound.DOCS8830:
description: 'Not Found - Note: This may be due to eventual consistency if the environment was recently created. Try again after a s
# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ping-identity/refs/heads/main/openapi/ping-identity-davinci-admin-connectors-api-openapi.yml