Update Store
PUT {{apiPath}}/environments/{{envID}}/propagation/stores/{{storeID}}
The PUT {{apiPath}}/environments/{{envID}}/propagation/stores/{{storeID}} operation updates the property values of the identified identity store resource.
Prerequisites
-
Refer to Identity Propagation (Provisioning) for important overview information.
Request Model
Base request model
Refer to Propagation store base data model for full property descriptions.
| Property | Type | Required? |
|---|---|---|
|
String |
Optional |
|
String |
Optional |
|
Boolean |
Optional |
|
String |
Required |
|
String |
Optional |
|
String |
Required |
Propagation store configuration request models:
Aquera configuration request model
Refer to Propagation store Aquera configuration data model for full property descriptions.
| Property | Type | Required? |
|---|---|---|
|
String |
Optional |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
Azure Active Directory SAML V2.0 configuration request model
Refer to Propagation store Azure Active Directory SAML V2.0 configuration data model for full property descriptions.
| Property | Type | Required? |
|---|---|---|
|
String |
Required |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
String |
Optional |
|
Boolean |
Optional |
|
Boolean |
Required |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
directory configuration request model
An identity propagation store of type directory has no configuration data model.
GoogleApps configuration request model
Refer to Propagation store GoogleApps configuration data model for full property descriptions.
| Property | Type | Required? |
|---|---|---|
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
Boolean |
Optional |
|
String |
Optional |
|
Boolean |
Optional |
GitHubEMU configuration request model
| Property | Type | Required? |
|---|---|---|
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
String |
Optional |
|
String |
Required |
|
String |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
LdapGateway configuration request model
Refer to Propagation store LDAP Gateway configuration data model for full property descriptions.
| Property | Type | Required? |
|---|---|---|
|
String |
Optional |
|
String |
Required |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
Boolean |
Optional |
PingOne configuration request model
Refer to Propagation store PingOne configuration data model for full property descriptions.
| Property | Type | Required? |
|---|---|---|
|
String |
Optional |
|
String |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
String |
Optional |
|
Boolean |
Optional |
|
Sring |
Required |
|
String |
Optional |
|
Boolean |
Optional |
|
String |
Required |
|
String |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
Salesforce configuration request model
Refer to Propagation store Salesforce configuration data model for full property descriptions.
| Property | Type | Required? |
|---|---|---|
|
String |
Optional |
|
String |
Required |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Required |
|
Boolean |
Required |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
String |
Optional |
|
Boolean |
Optional |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
SalesforceContacts configuration request model
Refer to Propagation store SalesforceContacts configuration data model for full property descriptions.
| Property | Type | Required? |
|---|---|---|
|
String |
Optional |
|
String |
Required |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Required |
|
Boolean |
Required |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
String |
Optional |
|
Boolean |
Optional |
|
String |
Required |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
SCIM configuration request model
Refer to Propagation store SCIM configuration data model for full property descriptions.
| Property | Type | Required? |
|---|---|---|
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
String |
Required |
|
String |
Required |
ServiceNow configuration request model
Refer to Propagation store ServiceNow configuration data model for full property descriptions.
| Property | Type | Required? |
|---|---|---|
|
String |
Required |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
Slack configuration request model
Refer to Propagation store Slack configuration data model for full property descriptions.
| Property | Type | Required? |
|---|---|---|
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
String |
Required |
|
String |
Optional |
|
Boolean |
Optional |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
Workday configuration request model
Refer to Propagation store Workday configuration data model for full property descriptions.
| Property | Type | Required? |
|---|---|---|
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
String |
Optional |
|
String |
Required |
|
String |
Required |
|
String |
Required |
Zoom configuration request model
Refer to Propagation store Zoom configuration data model for full property descriptions.
| Property | Type | Required? |
|---|---|---|
|
String |
Required |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
String |
Required/Optional |
|
String |
Required/Optional |
|
String |
Required/Optional |
|
String |
Required/Optional |
|
String |
Optional |
|
Boolean |
Optional |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
Body
raw ( application/json )
{
"type": "scim",
"name": "scim",
"description": "Update a scim connection",
"configuration": {
"AUTHENTICATION_METHOD": "Basic Authentication",
"SCIM_URL": "https://scim.url",
"USERS_RESOURCE": "/users",
"SCIM_VERSION": "1.1",
"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
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff --request PUT '{{apiPath}}/environments/{{envID}}/propagation/stores/{{storeID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"type": "scim",
"name": "scim",
"description": "Update a scim connection",
"configuration": {
"AUTHENTICATION_METHOD": "Basic Authentication",
"SCIM_URL": "https://scim.url",
"USERS_RESOURCE": "/users",
"SCIM_VERSION": "1.1",
"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/{{storeID}}")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Put);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@" ""type"": ""scim""," + "\n" +
@" ""name"": ""scim""," + "\n" +
@" ""description"": ""Update a scim connection""," + "\n" +
@" ""configuration"": {" + "\n" +
@" ""AUTHENTICATION_METHOD"": ""Basic Authentication""," + "\n" +
@" ""SCIM_URL"": ""https://scim.url""," + "\n" +
@" ""USERS_RESOURCE"": ""/users""," + "\n" +
@" ""SCIM_VERSION"": ""1.1""," + "\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/{{storeID}}"
method := "PUT"
payload := strings.NewReader(`{
"type": "scim",
"name": "scim",
"description": "Update a scim connection",
"configuration": {
"AUTHENTICATION_METHOD": "Basic Authentication",
"SCIM_URL": "https://scim.url",
"USERS_RESOURCE": "/users",
"SCIM_VERSION": "1.1",
"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/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))
}
PUT /environments/{{envID}}/propagation/stores/{{storeID}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"type": "scim",
"name": "scim",
"description": "Update a scim connection",
"configuration": {
"AUTHENTICATION_METHOD": "Basic Authentication",
"SCIM_URL": "https://scim.url",
"USERS_RESOURCE": "/users",
"SCIM_VERSION": "1.1",
"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/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"type\": \"scim\",\n \"name\": \"scim\",\n \"description\": \"Update a scim connection\",\n \"configuration\": {\n \"AUTHENTICATION_METHOD\": \"Basic Authentication\",\n \"SCIM_URL\": \"https://scim.url\",\n \"USERS_RESOURCE\": \"/users\",\n \"SCIM_VERSION\": \"1.1\",\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/{{storeID}}")
.method("PUT", body)
.addHeader("Content-Type", "application/json")
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/environments/{{envID}}/propagation/stores/{{storeID}}",
"method": "PUT",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"type": "scim",
"name": "scim",
"description": "Update a scim connection",
"configuration": {
"AUTHENTICATION_METHOD": "Basic Authentication",
"SCIM_URL": "https://scim.url",
"USERS_RESOURCE": "/users",
"SCIM_VERSION": "1.1",
"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': 'PUT',
'url': '{{apiPath}}/environments/{{envID}}/propagation/stores/{{storeID}}',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"type": "scim",
"name": "scim",
"description": "Update a scim connection",
"configuration": {
"AUTHENTICATION_METHOD": "Basic Authentication",
"SCIM_URL": "https://scim.url",
"USERS_RESOURCE": "/users",
"SCIM_VERSION": "1.1",
"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/{{storeID}}"
payload = json.dumps({
"type": "scim",
"name": "scim",
"description": "Update a scim connection",
"configuration": {
"AUTHENTICATION_METHOD": "Basic Authentication",
"SCIM_URL": "https://scim.url",
"USERS_RESOURCE": "/users",
"SCIM_VERSION": "1.1",
"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/json',
'Authorization': 'Bearer {{accessToken}}'
}
response = requests.request("PUT", 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/{{storeID}}');
$request->setMethod(HTTP_Request2::METHOD_PUT);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n "type": "scim",\n "name": "scim",\n "description": "Update a scim connection",\n "configuration": {\n "AUTHENTICATION_METHOD": "Basic Authentication",\n "SCIM_URL": "https://scim.url",\n "USERS_RESOURCE": "/users",\n "SCIM_VERSION": "1.1",\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/{{storeID}}")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
"type": "scim",
"name": "scim",
"description": "Update a scim connection",
"configuration": {
"AUTHENTICATION_METHOD": "Basic Authentication",
"SCIM_URL": "https://scim.url",
"USERS_RESOURCE": "/users",
"SCIM_VERSION": "1.1",
"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 \"description\": \"Update a scim connection\",\n \"configuration\": {\n \"AUTHENTICATION_METHOD\": \"Basic Authentication\",\n \"SCIM_URL\": \"https://scim.url\",\n \"USERS_RESOURCE\": \"/users\",\n \"SCIM_VERSION\": \"1.1\",\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/{{storeID}}")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")
request.httpMethod = "PUT"
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
{
"id": "a7115f69-136d-4b5d-8b24-5c1c218147f5",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"createdAt": "2022-01-10T17:32:21.502Z",
"updatedAt": "2022-01-10T20:29:55.593Z",
"image": {
"href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
},
"description": "Update a scim connection",
"type": "scim",
"configuration": {
"AUTHENTICATION_METHOD": "Basic Authentication",
"SCIM_URL": "https://scim.url",
"USERS_RESOURCE": "/users",
"SCIM_VERSION": "1.1",
"AUTHORIZATION_TYPE": "Basic",
"BASIC_AUTH_USER": "basicUserName",
"BASIC_AUTH_PASSWORD": "$3cr3t_p@55w0rd"
},
"name": "scim",
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/a7115f69-136d-4b5d-8b24-5c1c218147f5"
},
"update": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/a7115f69-136d-4b5d-8b24-5c1c218147f5"
},
"delete": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/a7115f69-136d-4b5d-8b24-5c1c218147f5"
}
}
}