Read All DaVinci Connector Instances

GET {{apiPath}}/environments/{{envID}}/connectorInstances

The GET {{apiPath}}/environments/{{envID}}/connectorInstances returns the complete list of connector instance resources associated with the specified environment.

Headers

Authorization Bearer {{accessToken}}

Example Request

curl --location --globoff '{{apiPath}}/environments/{{envID}}/connectorInstances' \
--header 'Authorization: Bearer {{accessToken}}'

var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/connectorInstances")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Authorization", "Bearer {{accessToken}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envID}}/connectorInstances"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

GET /environments/{{envID}}/connectorInstances HTTP/1.1
Host: {{apiPath}}
Authorization: Bearer {{accessToken}}

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/connectorInstances")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();

var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/connectorInstances",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer {{accessToken}}"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{apiPath}}/environments/{{envID}}/connectorInstances',
  'headers': {
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

import requests

url = "{{apiPath}}/environments/{{envID}}/connectorInstances"

payload = {}
headers = {
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/connectorInstances');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Authorization' => 'Bearer {{accessToken}}'
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

require "uri"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/connectorInstances")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer {{accessToken}}"

response = http.request(request)
puts response.read_body

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/connectorInstances")!,timeoutInterval: Double.infinity)
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

200 OK

{
    "_links": {
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances"
        }
    },
    "_embedded": {
        "connectorInstances": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/06922a684039827499bdbdd97f49827b"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "connectorInstance.clone": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/06922a684039827499bdbdd97f49827b"
                    }
                },
                "id": "06922a684039827499bdbdd97f49827b",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "connector": {
                    "id": "variablesConnector"
                },
                "name": "Variables",
                "createdAt": "2022-08-10T23:04:22.547Z",
                "updatedAt": "2022-08-10T23:04:22.547Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/06a1ed5c115dcdaaf88c94339f1ff003"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "connectorInstance.clone": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/06a1ed5c115dcdaaf88c94339f1ff003"
                    }
                },
                "id": "06a1ed5c115dcdaaf88c94339f1ff003",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "connector": {
                    "id": "pingOneSSOConnector"
                },
                "name": "P1_SSO_Connection",
                "createdAt": "2024-04-19T22:35:45.451Z",
                "updatedAt": "2024-04-19T22:35:45.451Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/092d0ddc26dc3c893479426989209a1c"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "connectorInstance.clone": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/092d0ddc26dc3c893479426989209a1c"
                    }
                },
                "id": "092d0ddc26dc3c893479426989209a1c",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "connector": {
                    "id": "amazonSimpleEmailConnector"
                },
                "name": "Amazon Simple Email [2022-12-08]",
                "createdAt": "2022-12-08T17:43:27.533Z",
                "updatedAt": "2022-12-08T17:43:27.533Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/3b55f2ca6689560c64cb5bed5afbe40f"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "connectorInstance.clone": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/3b55f2ca6689560c64cb5bed5afbe40f"
                    }
                },
                "id": "3b55f2ca6689560c64cb5bed5afbe40f",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "connector": {
                    "id": "skOpenIdConnector"
                },
                "name": "Token Management",
                "createdAt": "2022-08-10T23:04:20.372Z",
                "updatedAt": "2022-08-10T23:04:20.372Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/4cb5e3465d718a84087ec9b6a6251e52"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "connectorInstance.clone": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/4cb5e3465d718a84087ec9b6a6251e52"
                    }
                },
                "id": "4cb5e3465d718a84087ec9b6a6251e52",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "connector": {
                    "id": "userPolicyConnector"
                },
                "name": "User Policy",
                "createdAt": "2022-08-10T23:04:21.451Z",
                "updatedAt": "2022-08-10T23:04:21.451Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/6d8f6f706c45fd459a86b3f092602544"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "connectorInstance.clone": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/6d8f6f706c45fd459a86b3f092602544"
                    }
                },
                "id": "6d8f6f706c45fd459a86b3f092602544",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "connector": {
                    "id": "errorConnector"
                },
                "name": "Error Customize",
                "createdAt": "2022-08-10T23:04:16.242Z",
                "updatedAt": "2022-08-10T23:04:16.242Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/79116542dee548861b74efa8edef82af"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "connectorInstance.clone": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/79116542dee548861b74efa8edef82af"
                    }
                },
                "id": "79116542dee548861b74efa8edef82af",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "connector": {
                    "id": "challengeConnector"
                },
                "name": "Challenge [2022-12-08]",
                "createdAt": "2022-12-08T17:43:27.534Z",
                "updatedAt": "2022-12-08T17:43:27.534Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/867ed4363b2bc21c860085ad2baa817d"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "connectorInstance.clone": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/867ed4363b2bc21c860085ad2baa817d"
                    }
                },
                "id": "867ed4363b2bc21c860085ad2baa817d",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "connector": {
                    "id": "httpConnector"
                },
                "name": "Http",
                "createdAt": "2022-08-10T23:04:18.335Z",
                "updatedAt": "2022-08-10T23:04:18.335Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/921bfae85c38ed45045e07be703d86b8"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "connectorInstance.clone": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/921bfae85c38ed45045e07be703d86b8"
                    }
                },
                "id": "921bfae85c38ed45045e07be703d86b8",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "connector": {
                    "id": "annotationConnector"
                },
                "name": "Annotation",
                "createdAt": "2022-08-10T23:04:15.186Z",
                "updatedAt": "2022-08-10T23:04:15.186Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/94141bf2f1b9b59a5f5365ff135e02bb"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "connectorInstance.clone": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/94141bf2f1b9b59a5f5365ff135e02bb"
                    }
                },
                "id": "94141bf2f1b9b59a5f5365ff135e02bb",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "connector": {
                    "id": "pingOneSSOConnector"
                },
                "name": "PingOne",
                "properties": {
                    "clientId": {
                        "type": "string",
                        "displayName": "Client ID",
                        "createdDate": 1694542156295,
                        "customerId": "ecb9bf8a2fab854e65045d02cb6bab50",
                        "companyId": "singularkey",
                        "preferredControlType": "textField",
                        "info": "The Client ID of your PingOne Worker application.",
                        "sections": [
                            "pingOneEnvironment"
                        ],
                        "required": true,
                        "value": "2128619d-ed04-47c2-a648-424a496b18b7"
                    },
                    "clientSecret": {
                        "type": "string",
                        "displayName": "Client Secret",
                        "createdDate": 1694542156287,
                        "customerId": "ecb9bf8a2fab854e65045d02cb6bab50",
                        "companyId": "singularkey",
                        "preferredControlType": "textField",
                        "info": "The Client Secret of your PingOne Worker application.",
                        "secure": true,
                        "sections": [
                            "pingOneEnvironment"
                        ],
                        "required": true,
                        "value": "******"
                    },
                    "region": {
                        "type": "string",
                        "displayName": "Region",
                        "createdDate": 1694542156318,
                        "customerId": "ecb9bf8a2fab854e65045d02cb6bab50",
                        "companyId": "singularkey",
                        "preferredControlType": "dropDown",
                        "options": [
                            {
                                "name": "North America - US",
                                "value": "NA"
                            },
                            {
                                "name": "North America - Canada",
                                "value": "CA"
                            },
                            {
                                "name": "Europe",
                                "value": "EU"
                            },
                            {
                                "name": "Asia - Australia",
                                "value": "AP"
                            }
                        ],
                        "info": "The region in which your PingOne environment exists.",
                        "value": "NA",
                        "sections": [
                            "pingOneEnvironment"
                        ],
                        "required": true
                    },
                    "envId": {
                        "type": "string",
                        "displayName": "Environment ID",
                        "createdDate": 1694542156343,
                        "customerId": "ecb9bf8a2fab854e65045d02cb6bab50",
                        "companyId": "singularkey",
                        "preferredControlType": "textField",
                        "info": "Your PingOne environment ID.",
                        "required": true,
                        "value": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    }
                },
                "createdAt": "2022-08-10T23:04:19.324Z",
                "updatedAt": "2023-10-16T21:45:19.411Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/c7a4f5083bf23add2f95248b52017a1d"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "connectorInstance.clone": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/c7a4f5083bf23add2f95248b52017a1d"
                    }
                },
                "id": "c7a4f5083bf23add2f95248b52017a1d",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "connector": {
                    "id": "flowConnector"
                },
                "name": "Flow [2022-12-08]",
                "createdAt": "2022-12-08T17:43:27.532Z",
                "updatedAt": "2022-12-08T17:43:27.532Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/de650ca45593b82c49064ead10b9fe17"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "connectorInstance.clone": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/de650ca45593b82c49064ead10b9fe17"
                    }
                },
                "id": "de650ca45593b82c49064ead10b9fe17",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "connector": {
                    "id": "functionsConnector"
                },
                "name": "Functions",
                "createdAt": "2022-08-10T23:04:17.276Z",
                "updatedAt": "2022-08-10T23:04:17.276Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/defaultUserPool"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "connectorInstance.clone": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/defaultUserPool"
                    }
                },
                "id": "defaultUserPool",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "connector": {
                    "id": "skUserPool"
                },
                "name": "Default User Pool",
                "createdAt": "2022-08-10T23:04:11.895Z",
                "updatedAt": "2022-08-10T23:04:11.895Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/e8b26b2703ce91678e768fdb048a4b51"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "connectorInstance.clone": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/e8b26b2703ce91678e768fdb048a4b51"
                    }
                },
                "id": "e8b26b2703ce91678e768fdb048a4b51",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "connector": {
                    "id": "httpConnector"
                },
                "name": "API_HTTP_Connection",
                "createdAt": "2024-04-19T22:27:51.226Z",
                "updatedAt": "2024-04-19T22:27:51.226Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/eb9e42daeb7c3f94efde573253308219"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "connectorInstance.clone": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/connectorInstances/eb9e42daeb7c3f94efde573253308219"
                    }
                },
                "id": "eb9e42daeb7c3f94efde573253308219",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "connector": {
                    "id": "skUserPool"
                },
                "name": "Connection-UPDATED_1660689942",
                "createdAt": "2022-08-16T22:44:31.299Z",
                "updatedAt": "2022-08-16T22:45:42.285Z"
            }
        ]
    }
}