Test Connection Configuration

POST {{apiPath}}/environments/{{envID}}/propagation/stores/connection/status

The POST {{apiPath}}/environments/{{envID}}/propagation/stores/connection/status operation verifies identity store resource configuration in the specified environment resource. This operation uses the application/vnd.pingidentity.connection.check+json custom media type as the content type in the request header. This call is prospective; that is, you can test whether a proposed configuration will be accepted.

Headers

Authorization Bearer {{accessToken}}

Content-Type application/vnd.pingidentity.connection.check+json

Body

raw ( application/vnd.pingidentity.connection.check+json )

{
    "type": "scim",
    "name": "scim",
    "configuration": {
        "AUTHENTICATION_METHOD": "None",
        "USER_FILTER": "username Eq \"%s\"",
        "UNIQUE_USER_IDENTIFIER": "userName",
        "REMOVE_ACTION": "Disable",
        "CREATE_USERS": true,
        "UPDATE_USERS": true,
        "DISABLE_USERS": true,
        "USERS_RESOURCE": "/Users",
        "SCIM_VERSION": "2.0",
        "SCIM_URL": "https://example.com",
        "AUTHORIZATION_TYPE": "Basic",
        "BASIC_AUTH_USER": "{{basicAuthUsername}}",
        "BASIC_AUTH_PASSWORD": "{{basicAuthPassword}}"
    },
    "image": {
        "href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
    }
}

Example Request

curl --location --globoff '{{apiPath}}/environments/{{envID}}/propagation/stores/connection/status' \
--header 'Content-Type: application/vnd.pingidentity.connection.check+json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "type": "scim",
    "name": "scim",
    "configuration": {
        "AUTHENTICATION_METHOD": "None",
        "USER_FILTER": "username Eq \"%s\"",
        "UNIQUE_USER_IDENTIFIER": "userName",
        "REMOVE_ACTION": "Disable",
        "CREATE_USERS": true,
        "UPDATE_USERS": true,
        "DISABLE_USERS": true,
        "USERS_RESOURCE": "/Users",
        "SCIM_VERSION": "2.0",
        "SCIM_URL": "https://example.com",
        "AUTHORIZATION_TYPE": "Basic",
        "BASIC_AUTH_USER": "{{basicAuthUsername}}",
        "BASIC_AUTH_PASSWORD": "{{basicAuthPassword}}"
    },
    "image": {
        "href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
    }
}'

var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/propagation/stores/connection/status")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/vnd.pingidentity.connection.check+json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"    ""type"": ""scim""," + "\n" +
@"    ""name"": ""scim""," + "\n" +
@"    ""configuration"": {" + "\n" +
@"        ""AUTHENTICATION_METHOD"": ""None""," + "\n" +
@"        ""USER_FILTER"": ""username Eq \""%s\""""," + "\n" +
@"        ""UNIQUE_USER_IDENTIFIER"": ""userName""," + "\n" +
@"        ""REMOVE_ACTION"": ""Disable""," + "\n" +
@"        ""CREATE_USERS"": true," + "\n" +
@"        ""UPDATE_USERS"": true," + "\n" +
@"        ""DISABLE_USERS"": true," + "\n" +
@"        ""USERS_RESOURCE"": ""/Users""," + "\n" +
@"        ""SCIM_VERSION"": ""2.0""," + "\n" +
@"        ""SCIM_URL"": ""https://example.com""," + "\n" +
@"        ""AUTHORIZATION_TYPE"": ""Basic""," + "\n" +
@"        ""BASIC_AUTH_USER"": ""{{basicAuthUsername}}""," + "\n" +
@"        ""BASIC_AUTH_PASSWORD"": ""{{basicAuthPassword}}""" + "\n" +
@"    }," + "\n" +
@"    ""image"": {" + "\n" +
@"        ""href"": ""https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png""" + "\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/stores/connection/status"
  method := "POST"

  payload := strings.NewReader(`{
    "type": "scim",
    "name": "scim",
    "configuration": {
        "AUTHENTICATION_METHOD": "None",
        "USER_FILTER": "username Eq \"%s\"",
        "UNIQUE_USER_IDENTIFIER": "userName",
        "REMOVE_ACTION": "Disable",
        "CREATE_USERS": true,
        "UPDATE_USERS": true,
        "DISABLE_USERS": true,
        "USERS_RESOURCE": "/Users",
        "SCIM_VERSION": "2.0",
        "SCIM_URL": "https://example.com",
        "AUTHORIZATION_TYPE": "Basic",
        "BASIC_AUTH_USER": "{{basicAuthUsername}}",
        "BASIC_AUTH_PASSWORD": "{{basicAuthPassword}}"
    },
    "image": {
        "href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
    }
}`)

  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.connection.check+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/stores/connection/status HTTP/1.1
Host: {{apiPath}}
Content-Type: application/vnd.pingidentity.connection.check+json
Authorization: Bearer {{accessToken}}

{
    "type": "scim",
    "name": "scim",
    "configuration": {
        "AUTHENTICATION_METHOD": "None",
        "USER_FILTER": "username Eq \"%s\"",
        "UNIQUE_USER_IDENTIFIER": "userName",
        "REMOVE_ACTION": "Disable",
        "CREATE_USERS": true,
        "UPDATE_USERS": true,
        "DISABLE_USERS": true,
        "USERS_RESOURCE": "/Users",
        "SCIM_VERSION": "2.0",
        "SCIM_URL": "https://example.com",
        "AUTHORIZATION_TYPE": "Basic",
        "BASIC_AUTH_USER": "{{basicAuthUsername}}",
        "BASIC_AUTH_PASSWORD": "{{basicAuthPassword}}"
    },
    "image": {
        "href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
    }
}

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/vnd.pingidentity.connection.check+json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"type\": \"scim\",\n    \"name\": \"scim\",\n    \"configuration\": {\n        \"AUTHENTICATION_METHOD\": \"None\",\n        \"USER_FILTER\": \"username Eq \\\"%s\\\"\",\n        \"UNIQUE_USER_IDENTIFIER\": \"userName\",\n        \"REMOVE_ACTION\": \"Disable\",\n        \"CREATE_USERS\": true,\n        \"UPDATE_USERS\": true,\n        \"DISABLE_USERS\": true,\n        \"USERS_RESOURCE\": \"/Users\",\n        \"SCIM_VERSION\": \"2.0\",\n        \"SCIM_URL\": \"https://example.com\",\n        \"AUTHORIZATION_TYPE\": \"Basic\",\n        \"BASIC_AUTH_USER\": \"{{basicAuthUsername}}\",\n        \"BASIC_AUTH_PASSWORD\": \"{{basicAuthPassword}}\"\n    },\n    \"image\": {\n        \"href\": \"https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png\"\n    }\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/propagation/stores/connection/status")
  .method("POST", body)
  .addHeader("Content-Type", "application/vnd.pingidentity.connection.check+json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();

var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/propagation/stores/connection/status",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/vnd.pingidentity.connection.check+json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "type": "scim",
    "name": "scim",
    "configuration": {
      "AUTHENTICATION_METHOD": "None",
      "USER_FILTER": "username Eq \"%s\"",
      "UNIQUE_USER_IDENTIFIER": "userName",
      "REMOVE_ACTION": "Disable",
      "CREATE_USERS": true,
      "UPDATE_USERS": true,
      "DISABLE_USERS": true,
      "USERS_RESOURCE": "/Users",
      "SCIM_VERSION": "2.0",
      "SCIM_URL": "https://example.com",
      "AUTHORIZATION_TYPE": "Basic",
      "BASIC_AUTH_USER": "{{basicAuthUsername}}",
      "BASIC_AUTH_PASSWORD": "{{basicAuthPassword}}"
    },
    "image": {
      "href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
    }
  }),
};

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

var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/propagation/stores/connection/status',
  'headers': {
    'Content-Type': 'application/vnd.pingidentity.connection.check+json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "type": "scim",
    "name": "scim",
    "configuration": {
      "AUTHENTICATION_METHOD": "None",
      "USER_FILTER": "username Eq \"%s\"",
      "UNIQUE_USER_IDENTIFIER": "userName",
      "REMOVE_ACTION": "Disable",
      "CREATE_USERS": true,
      "UPDATE_USERS": true,
      "DISABLE_USERS": true,
      "USERS_RESOURCE": "/Users",
      "SCIM_VERSION": "2.0",
      "SCIM_URL": "https://example.com",
      "AUTHORIZATION_TYPE": "Basic",
      "BASIC_AUTH_USER": "{{basicAuthUsername}}",
      "BASIC_AUTH_PASSWORD": "{{basicAuthPassword}}"
    },
    "image": {
      "href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
    }
  })

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

import requests
import json

url = "{{apiPath}}/environments/{{envID}}/propagation/stores/connection/status"

payload = json.dumps({
  "type": "scim",
  "name": "scim",
  "configuration": {
    "AUTHENTICATION_METHOD": "None",
    "USER_FILTER": "username Eq \"%s\"",
    "UNIQUE_USER_IDENTIFIER": "userName",
    "REMOVE_ACTION": "Disable",
    "CREATE_USERS": True,
    "UPDATE_USERS": True,
    "DISABLE_USERS": True,
    "USERS_RESOURCE": "/Users",
    "SCIM_VERSION": "2.0",
    "SCIM_URL": "https://example.com",
    "AUTHORIZATION_TYPE": "Basic",
    "BASIC_AUTH_USER": "{{basicAuthUsername}}",
    "BASIC_AUTH_PASSWORD": "{{basicAuthPassword}}"
  },
  "image": {
    "href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
  }
})
headers = {
  'Content-Type': 'application/vnd.pingidentity.connection.check+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/stores/connection/status');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/vnd.pingidentity.connection.check+json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n    "type": "scim",\n    "name": "scim",\n    "configuration": {\n        "AUTHENTICATION_METHOD": "None",\n        "USER_FILTER": "username Eq \\"%s\\"",\n        "UNIQUE_USER_IDENTIFIER": "userName",\n        "REMOVE_ACTION": "Disable",\n        "CREATE_USERS": true,\n        "UPDATE_USERS": true,\n        "DISABLE_USERS": true,\n        "USERS_RESOURCE": "/Users",\n        "SCIM_VERSION": "2.0",\n        "SCIM_URL": "https://example.com",\n        "AUTHORIZATION_TYPE": "Basic",\n        "BASIC_AUTH_USER": "{{basicAuthUsername}}",\n        "BASIC_AUTH_PASSWORD": "{{basicAuthPassword}}"\n    },\n    "image": {\n        "href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"\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/stores/connection/status")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/vnd.pingidentity.connection.check+json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "type": "scim",
  "name": "scim",
  "configuration": {
    "AUTHENTICATION_METHOD": "None",
    "USER_FILTER": "username Eq \"%s\"",
    "UNIQUE_USER_IDENTIFIER": "userName",
    "REMOVE_ACTION": "Disable",
    "CREATE_USERS": true,
    "UPDATE_USERS": true,
    "DISABLE_USERS": true,
    "USERS_RESOURCE": "/Users",
    "SCIM_VERSION": "2.0",
    "SCIM_URL": "https://example.com",
    "AUTHORIZATION_TYPE": "Basic",
    "BASIC_AUTH_USER": "{{basicAuthUsername}}",
    "BASIC_AUTH_PASSWORD": "{{basicAuthPassword}}"
  },
  "image": {
    "href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
  }
})

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

let parameters = "{\n    \"type\": \"scim\",\n    \"name\": \"scim\",\n    \"configuration\": {\n        \"AUTHENTICATION_METHOD\": \"None\",\n        \"USER_FILTER\": \"username Eq \\\"%s\\\"\",\n        \"UNIQUE_USER_IDENTIFIER\": \"userName\",\n        \"REMOVE_ACTION\": \"Disable\",\n        \"CREATE_USERS\": true,\n        \"UPDATE_USERS\": true,\n        \"DISABLE_USERS\": true,\n        \"USERS_RESOURCE\": \"/Users\",\n        \"SCIM_VERSION\": \"2.0\",\n        \"SCIM_URL\": \"https://example.com\",\n        \"AUTHORIZATION_TYPE\": \"Basic\",\n        \"BASIC_AUTH_USER\": \"{{basicAuthUsername}}\",\n        \"BASIC_AUTH_PASSWORD\": \"{{basicAuthPassword}}\"\n    },\n    \"image\": {\n        \"href\": \"https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png\"\n    }\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/propagation/stores/connection/status")!,timeoutInterval: Double.infinity)
request.addValue("application/vnd.pingidentity.connection.check+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

PingOne Platform APIs

Test Connection Configuration

Headers

Body

Example Request

Example Response