PingOne Platform APIs

Import External Groups

 

POST {{apiPath}}/environments/{{envID}}/propagation/provisioningSyncs/{{provisioningSyncID}}

The POST {{apiPath}}/environments/{{envID}}/propagation/provisioningSyncs/{{provisioningSyncID}} operation uploads a collection of groups from a source connection, such as an LDAP server.

Request Model

Refer to External groups data model for full property descriptions.

Property Type Required?

groups

Object

Required

groups.operation

String

Optional

groups.uniqueId

String

Required

groups.attributes

Map

Required

groups.attributes.active

Boolean

Optional

groups.attributes.member

Array of Strings

Optional

nextToken

String

Optional

startToken

String

Optional

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/vnd.pingidentity.propagation.provisioningsync.groupimport+json

Body

raw ( application/vnd.pingidentity.propagation.provisioningsync.groupimport+json )

{
  "startToken": "{{startToken}}",
  "nextToken": "{{nextToken}}",
  "groups": [
    {
      "operation": "DELETED",
      "attributes": {
        "name": "DemoUsers2024\nDEL:6e04f620-1742-4d83-9828-b94433856b9a",
        "objectguid": [
          "{{objectguid}}"
        ],
        "member": [
          "{{member}}"
        ],
        "active": "true",
        "dn": "CN=DemoUsers2024,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global"
      },
      "uniqueId": "{{uniqueId}}"
    },
    {
      "operation": "DELETED",
      "attributes": {
        "name": "TestAccounts\nDEL:7ca065e3-cdf6-4ab0-add3-31563799ec27",
        "objectguid": [
          "{{objectguid}}"
        ],
        "member": [
          "{{member}}"
        ],
        "active": "true",
        "dn": "CN=TestAccounts,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global"
      },
      "uniqueId": "{{uniqueId}}"
    }
  ]
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/propagation/provisioningSyncs/{{provisioningSyncID}}' \
--header 'Content-Type: application/vnd.pingidentity.propagation.provisioningsync.groupimport+json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
  "startToken": "{{startToken}}",
  "nextToken": "{{nextToken}}",
  "groups": [
    {
      "operation": "DELETED",
      "attributes": {
        "name": "DemoUsers2024\nDEL:6e04f620-1742-4d83-9828-b94433856b9a",
        "objectguid": [
          "{{objectguid}}"
        ],
        "member": [
          "{{member}}"
        ],
        "active": "true",
        "dn": "CN=DemoUsers2024,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global"
      },
      "uniqueId": "{{uniqueId}}"
    },
    {
      "operation": "DELETED",
      "attributes": {
        "name": "TestAccounts\nDEL:7ca065e3-cdf6-4ab0-add3-31563799ec27",
        "objectguid": [
          "{{objectguid}}"
        ],
        "member": [
          "{{member}}"
        ],
        "active": "true",
        "dn": "CN=TestAccounts,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global"
      },
      "uniqueId": "{{uniqueId}}"
    }
  ]
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/propagation/provisioningSyncs/{{provisioningSyncID}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/vnd.pingidentity.propagation.provisioningsync.groupimport+json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"  ""startToken"": ""{{startToken}}""," + "\n" +
@"  ""nextToken"": ""{{nextToken}}""," + "\n" +
@"  ""groups"": [" + "\n" +
@"    {" + "\n" +
@"      ""operation"": ""DELETED""," + "\n" +
@"      ""attributes"": {" + "\n" +
@"        ""name"": ""DemoUsers2024\nDEL:6e04f620-1742-4d83-9828-b94433856b9a""," + "\n" +
@"        ""objectguid"": [" + "\n" +
@"          ""{{objectguid}}""" + "\n" +
@"        ]," + "\n" +
@"        ""member"": [" + "\n" +
@"          ""{{member}}""" + "\n" +
@"        ]," + "\n" +
@"        ""active"": ""true""," + "\n" +
@"        ""dn"": ""CN=DemoUsers2024,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global""" + "\n" +
@"      }," + "\n" +
@"      ""uniqueId"": ""{{uniqueId}}""" + "\n" +
@"    }," + "\n" +
@"    {" + "\n" +
@"      ""operation"": ""DELETED""," + "\n" +
@"      ""attributes"": {" + "\n" +
@"        ""name"": ""TestAccounts\nDEL:7ca065e3-cdf6-4ab0-add3-31563799ec27""," + "\n" +
@"        ""objectguid"": [" + "\n" +
@"          ""{{objectguid}}""" + "\n" +
@"        ]," + "\n" +
@"        ""member"": [" + "\n" +
@"          ""{{member}}""" + "\n" +
@"        ]," + "\n" +
@"        ""active"": ""true""," + "\n" +
@"        ""dn"": ""CN=TestAccounts,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global""" + "\n" +
@"      }," + "\n" +
@"      ""uniqueId"": ""{{uniqueId}}""" + "\n" +
@"    }" + "\n" +
@"  ]" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

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

func main() {

  url := "{{apiPath}}/environments/{{envID}}/propagation/provisioningSyncs/{{provisioningSyncID}}"
  method := "POST"

  payload := strings.NewReader(`{
  "startToken": "{{startToken}}",
  "nextToken": "{{nextToken}}",
  "groups": [
    {
      "operation": "DELETED",
      "attributes": {
        "name": "DemoUsers2024\nDEL:6e04f620-1742-4d83-9828-b94433856b9a",
        "objectguid": [
          "{{objectguid}}"
        ],
        "member": [
          "{{member}}"
        ],
        "active": "true",
        "dn": "CN=DemoUsers2024,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global"
      },
      "uniqueId": "{{uniqueId}}"
    },
    {
      "operation": "DELETED",
      "attributes": {
        "name": "TestAccounts\nDEL:7ca065e3-cdf6-4ab0-add3-31563799ec27",
        "objectguid": [
          "{{objectguid}}"
        ],
        "member": [
          "{{member}}"
        ],
        "active": "true",
        "dn": "CN=TestAccounts,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global"
      },
      "uniqueId": "{{uniqueId}}"
    }
  ]
}`)

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

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/vnd.pingidentity.propagation.provisioningsync.groupimport+json")
  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))
}
POST /environments/{{envID}}/propagation/provisioningSyncs/{{provisioningSyncID}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/vnd.pingidentity.propagation.provisioningsync.groupimport+json
Authorization: Bearer {{accessToken}}

{
  "startToken": "{{startToken}}",
  "nextToken": "{{nextToken}}",
  "groups": [
    {
      "operation": "DELETED",
      "attributes": {
        "name": "DemoUsers2024\nDEL:6e04f620-1742-4d83-9828-b94433856b9a",
        "objectguid": [
          "{{objectguid}}"
        ],
        "member": [
          "{{member}}"
        ],
        "active": "true",
        "dn": "CN=DemoUsers2024,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global"
      },
      "uniqueId": "{{uniqueId}}"
    },
    {
      "operation": "DELETED",
      "attributes": {
        "name": "TestAccounts\nDEL:7ca065e3-cdf6-4ab0-add3-31563799ec27",
        "objectguid": [
          "{{objectguid}}"
        ],
        "member": [
          "{{member}}"
        ],
        "active": "true",
        "dn": "CN=TestAccounts,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global"
      },
      "uniqueId": "{{uniqueId}}"
    }
  ]
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/vnd.pingidentity.propagation.provisioningsync.groupimport+json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"startToken\": \"{{startToken}}\",\n  \"nextToken\": \"{{nextToken}}\",\n  \"groups\": [\n    {\n      \"operation\": \"DELETED\",\n      \"attributes\": {\n        \"name\": \"DemoUsers2024\\nDEL:6e04f620-1742-4d83-9828-b94433856b9a\",\n        \"objectguid\": [\n          \"{{objectguid}}\"\n        ],\n        \"member\": [\n          \"{{member}}\"\n        ],\n        \"active\": \"true\",\n        \"dn\": \"CN=DemoUsers2024,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global\"\n      },\n      \"uniqueId\": \"{{uniqueId}}\"\n    },\n    {\n      \"operation\": \"DELETED\",\n      \"attributes\": {\n        \"name\": \"TestAccounts\\nDEL:7ca065e3-cdf6-4ab0-add3-31563799ec27\",\n        \"objectguid\": [\n          \"{{objectguid}}\"\n        ],\n        \"member\": [\n          \"{{member}}\"\n        ],\n        \"active\": \"true\",\n        \"dn\": \"CN=TestAccounts,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global\"\n      },\n      \"uniqueId\": \"{{uniqueId}}\"\n    }\n  ]\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/propagation/provisioningSyncs/{{provisioningSyncID}}")
  .method("POST", body)
  .addHeader("Content-Type", "application/vnd.pingidentity.propagation.provisioningsync.groupimport+json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/propagation/provisioningSyncs/{{provisioningSyncID}}",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/vnd.pingidentity.propagation.provisioningsync.groupimport+json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "startToken": "{{startToken}}",
    "nextToken": "{{nextToken}}",
    "groups": [
      {
        "operation": "DELETED",
        "attributes": {
          "name": "DemoUsers2024\nDEL:6e04f620-1742-4d83-9828-b94433856b9a",
          "objectguid": [
            "{{objectguid}}"
          ],
          "member": [
            "{{member}}"
          ],
          "active": "true",
          "dn": "CN=DemoUsers2024,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global"
        },
        "uniqueId": "{{uniqueId}}"
      },
      {
        "operation": "DELETED",
        "attributes": {
          "name": "TestAccounts\nDEL:7ca065e3-cdf6-4ab0-add3-31563799ec27",
          "objectguid": [
            "{{objectguid}}"
          ],
          "member": [
            "{{member}}"
          ],
          "active": "true",
          "dn": "CN=TestAccounts,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global"
        },
        "uniqueId": "{{uniqueId}}"
      }
    ]
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/propagation/provisioningSyncs/{{provisioningSyncID}}',
  'headers': {
    'Content-Type': 'application/vnd.pingidentity.propagation.provisioningsync.groupimport+json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "startToken": "{{startToken}}",
    "nextToken": "{{nextToken}}",
    "groups": [
      {
        "operation": "DELETED",
        "attributes": {
          "name": "DemoUsers2024\nDEL:6e04f620-1742-4d83-9828-b94433856b9a",
          "objectguid": [
            "{{objectguid}}"
          ],
          "member": [
            "{{member}}"
          ],
          "active": "true",
          "dn": "CN=DemoUsers2024,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global"
        },
        "uniqueId": "{{uniqueId}}"
      },
      {
        "operation": "DELETED",
        "attributes": {
          "name": "TestAccounts\nDEL:7ca065e3-cdf6-4ab0-add3-31563799ec27",
          "objectguid": [
            "{{objectguid}}"
          ],
          "member": [
            "{{member}}"
          ],
          "active": "true",
          "dn": "CN=TestAccounts,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global"
        },
        "uniqueId": "{{uniqueId}}"
      }
    ]
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{apiPath}}/environments/{{envID}}/propagation/provisioningSyncs/{{provisioningSyncID}}"

payload = json.dumps({
  "startToken": "{{startToken}}",
  "nextToken": "{{nextToken}}",
  "groups": [
    {
      "operation": "DELETED",
      "attributes": {
        "name": "DemoUsers2024\nDEL:6e04f620-1742-4d83-9828-b94433856b9a",
        "objectguid": [
          "{{objectguid}}"
        ],
        "member": [
          "{{member}}"
        ],
        "active": "true",
        "dn": "CN=DemoUsers2024,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global"
      },
      "uniqueId": "{{uniqueId}}"
    },
    {
      "operation": "DELETED",
      "attributes": {
        "name": "TestAccounts\nDEL:7ca065e3-cdf6-4ab0-add3-31563799ec27",
        "objectguid": [
          "{{objectguid}}"
        ],
        "member": [
          "{{member}}"
        ],
        "active": "true",
        "dn": "CN=TestAccounts,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global"
      },
      "uniqueId": "{{uniqueId}}"
    }
  ]
})
headers = {
  'Content-Type': 'application/vnd.pingidentity.propagation.provisioningsync.groupimport+json',
  'Authorization': 'Bearer {{accessToken}}'
}

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

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/propagation/provisioningSyncs/{{provisioningSyncID}}');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/vnd.pingidentity.propagation.provisioningsync.groupimport+json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n  "startToken": "{{startToken}}",\n  "nextToken": "{{nextToken}}",\n  "groups": [\n    {\n      "operation": "DELETED",\n      "attributes": {\n        "name": "DemoUsers2024\\nDEL:6e04f620-1742-4d83-9828-b94433856b9a",\n        "objectguid": [\n          "{{objectguid}}"\n        ],\n        "member": [\n          "{{member}}"\n        ],\n        "active": "true",\n        "dn": "CN=DemoUsers2024,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global"\n      },\n      "uniqueId": "{{uniqueId}}"\n    },\n    {\n      "operation": "DELETED",\n      "attributes": {\n        "name": "TestAccounts\\nDEL:7ca065e3-cdf6-4ab0-add3-31563799ec27",\n        "objectguid": [\n          "{{objectguid}}"\n        ],\n        "member": [\n          "{{member}}"\n        ],\n        "active": "true",\n        "dn": "CN=TestAccounts,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global"\n      },\n      "uniqueId": "{{uniqueId}}"\n    }\n  ]\n}');
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 "json"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/propagation/provisioningSyncs/{{provisioningSyncID}}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/vnd.pingidentity.propagation.provisioningsync.groupimport+json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "startToken": "{{startToken}}",
  "nextToken": "{{nextToken}}",
  "groups": [
    {
      "operation": "DELETED",
      "attributes": {
        "name": "DemoUsers2024\nDEL:6e04f620-1742-4d83-9828-b94433856b9a",
        "objectguid": [
          "{{objectguid}}"
        ],
        "member": [
          "{{member}}"
        ],
        "active": "true",
        "dn": "CN=DemoUsers2024,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global"
      },
      "uniqueId": "{{uniqueId}}"
    },
    {
      "operation": "DELETED",
      "attributes": {
        "name": "TestAccounts\nDEL:7ca065e3-cdf6-4ab0-add3-31563799ec27",
        "objectguid": [
          "{{objectguid}}"
        ],
        "member": [
          "{{member}}"
        ],
        "active": "true",
        "dn": "CN=TestAccounts,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global"
      },
      "uniqueId": "{{uniqueId}}"
    }
  ]
})

response = http.request(request)
puts response.read_body
let parameters = "{\n  \"startToken\": \"{{startToken}}\",\n  \"nextToken\": \"{{nextToken}}\",\n  \"groups\": [\n    {\n      \"operation\": \"DELETED\",\n      \"attributes\": {\n        \"name\": \"DemoUsers2024\\nDEL:6e04f620-1742-4d83-9828-b94433856b9a\",\n        \"objectguid\": [\n          \"{{objectguid}}\"\n        ],\n        \"member\": [\n          \"{{member}}\"\n        ],\n        \"active\": \"true\",\n        \"dn\": \"CN=DemoUsers2024,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global\"\n      },\n      \"uniqueId\": \"{{uniqueId}}\"\n    },\n    {\n      \"operation\": \"DELETED\",\n      \"attributes\": {\n        \"name\": \"TestAccounts\\nDEL:7ca065e3-cdf6-4ab0-add3-31563799ec27\",\n        \"objectguid\": [\n          \"{{objectguid}}\"\n        ],\n        \"member\": [\n          \"{{member}}\"\n        ],\n        \"active\": \"true\",\n        \"dn\": \"CN=TestAccounts,OU=Demo-BLR,DC=prov-ldap-mli2,DC=global\"\n      },\n      \"uniqueId\": \"{{uniqueId}}\"\n    }\n  ]\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/propagation/provisioningSyncs/{{provisioningSyncID}}")!,timeoutInterval: Double.infinity)
request.addValue("application/vnd.pingidentity.propagation.provisioningsync.groupimport+json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "POST"
request.httpBody = postData

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