Modify a Connection Profile

Update the details of a specific Connection Profile.

PATCH https://{tenantDomain}/api/v2/connection-profiles/{id}

Modify a Connection Profile

cURL

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/connection-profiles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "organization": {},
  "connection_name_prefix_template": "<string>",
  "enabled_features": [],
  "connection_config": {},
  "strategy_overrides": {
    "pingfederate": {
      "enabled_features": [],
      "connection_config": {}
    },
    "ad": {
      "enabled_features": [],
      "connection_config": {}
    },
    "adfs": {
      "enabled_features": [],
      "connection_config": {}
    },
    "waad": {
      "enabled_features": [],
      "connection_config": {}
    },
    "google-apps": {
      "enabled_features": [],
      "connection_config": {}
    },
    "okta": {
      "enabled_features": [],
      "connection_config": {}
    },
    "oidc": {
      "enabled_features": [],
      "connection_config": {}
    },
    "samlp": {
      "enabled_features": [],
      "connection_config": {}
    }
  }
}
'

import requests

url = "https://{tenantDomain}/api/v2/connection-profiles/{id}"

payload = {
    "name": "<string>",
    "organization": {},
    "connection_name_prefix_template": "<string>",
    "enabled_features": [],
    "connection_config": {},
    "strategy_overrides": {
        "pingfederate": {
            "enabled_features": [],
            "connection_config": {}
        },
        "ad": {
            "enabled_features": [],
            "connection_config": {}
        },
        "adfs": {
            "enabled_features": [],
            "connection_config": {}
        },
        "waad": {
            "enabled_features": [],
            "connection_config": {}
        },
        "google-apps": {
            "enabled_features": [],
            "connection_config": {}
        },
        "okta": {
            "enabled_features": [],
            "connection_config": {}
        },
        "oidc": {
            "enabled_features": [],
            "connection_config": {}
        },
        "samlp": {
            "enabled_features": [],
            "connection_config": {}
        }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    organization: {},
    connection_name_prefix_template: '<string>',
    enabled_features: [],
    connection_config: {},
    strategy_overrides: {
      pingfederate: {enabled_features: [], connection_config: {}},
      ad: {enabled_features: [], connection_config: {}},
      adfs: {enabled_features: [], connection_config: {}},
      waad: {enabled_features: [], connection_config: {}},
      'google-apps': {enabled_features: [], connection_config: {}},
      okta: {enabled_features: [], connection_config: {}},
      oidc: {enabled_features: [], connection_config: {}},
      samlp: {enabled_features: [], connection_config: {}}
    }
  })
};

fetch('https://{tenantDomain}/api/v2/connection-profiles/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/connection-profiles/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'organization' => [
        
    ],
    'connection_name_prefix_template' => '<string>',
    'enabled_features' => [
        
    ],
    'connection_config' => [
        
    ],
    'strategy_overrides' => [
        'pingfederate' => [
                'enabled_features' => [
                                
                ],
                'connection_config' => [
                                
                ]
        ],
        'ad' => [
                'enabled_features' => [
                                
                ],
                'connection_config' => [
                                
                ]
        ],
        'adfs' => [
                'enabled_features' => [
                                
                ],
                'connection_config' => [
                                
                ]
        ],
        'waad' => [
                'enabled_features' => [
                                
                ],
                'connection_config' => [
                                
                ]
        ],
        'google-apps' => [
                'enabled_features' => [
                                
                ],
                'connection_config' => [
                                
                ]
        ],
        'okta' => [
                'enabled_features' => [
                                
                ],
                'connection_config' => [
                                
                ]
        ],
        'oidc' => [
                'enabled_features' => [
                                
                ],
                'connection_config' => [
                                
                ]
        ],
        'samlp' => [
                'enabled_features' => [
                                
                ],
                'connection_config' => [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://{tenantDomain}/api/v2/connection-profiles/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"organization\": {},\n  \"connection_name_prefix_template\": \"<string>\",\n  \"enabled_features\": [],\n  \"connection_config\": {},\n  \"strategy_overrides\": {\n    \"pingfederate\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"ad\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"adfs\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"waad\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"google-apps\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"okta\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"oidc\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"samlp\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/api/v2/connection-profiles/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"organization\": {},\n  \"connection_name_prefix_template\": \"<string>\",\n  \"enabled_features\": [],\n  \"connection_config\": {},\n  \"strategy_overrides\": {\n    \"pingfederate\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"ad\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"adfs\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"waad\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"google-apps\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"okta\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"oidc\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"samlp\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/connection-profiles/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"organization\": {},\n  \"connection_name_prefix_template\": \"<string>\",\n  \"enabled_features\": [],\n  \"connection_config\": {},\n  \"strategy_overrides\": {\n    \"pingfederate\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"ad\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"adfs\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"waad\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"google-apps\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"okta\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"oidc\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"samlp\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    }\n  }\n}"

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

200

{
  "id": "<string>",
  "name": "<string>",
  "organization": {},
  "connection_name_prefix_template": "<string>",
  "enabled_features": [],
  "connection_config": {},
  "strategy_overrides": {
    "pingfederate": {
      "enabled_features": [],
      "connection_config": {}
    },
    "ad": {
      "enabled_features": [],
      "connection_config": {}
    },
    "adfs": {
      "enabled_features": [],
      "connection_config": {}
    },
    "waad": {
      "enabled_features": [],
      "connection_config": {}
    },
    "google-apps": {
      "enabled_features": [],
      "connection_config": {}
    },
    "okta": {
      "enabled_features": [],
      "connection_config": {}
    },
    "oidc": {
      "enabled_features": [],
      "connection_config": {}
    },
    "samlp": {
      "enabled_features": [],
      "connection_config": {}
    }
  }
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

パスパラメータ

id · string · 必須

ID of the connection profile to update.

ボディ

application/jsonapplication/x-www-form-urlencoded

name · string

The name of the connection profile.

Required string length: 1 - 50

organization · object

The organization of the connection profile.

Show child attributes

connection_name_prefix_template · string

Connection name prefix template.

Maximum string length: 15

Pattern: ^(?!-)(?!.*--)(?:[a-zA-Z0-9-]|{org_id}|{org_name})*$

enabled_features · enum<string>[]

Enabled features for the connection profile.

Enum for enabled features.

利用可能なオプション: scim, universal_logout

connection_config · object

Connection profile configuration.

strategy_overrides · object

Strategy-specific overrides for this attribute

Show child attributes

レスポンス

200

application/json

Connection profile successfully updated.

id · string<connection-profile-id>

Connection Profile identifier.

name · string

The name of the connection profile.

Required string length: 1 - 50

organization · object

The organization of the connection profile.

Show child attributes

connection_name_prefix_template · string

Connection name prefix template.

Maximum string length: 15

Pattern: ^(?!-)(?!.*--)(?:[a-zA-Z0-9-]|{org_id}|{org_name})*$

enabled_features · enum<string>[]

Enabled features for the connection profile.

Enum for enabled features.

利用可能なオプション: scim, universal_logout

connection_config · object

Connection profile configuration.

strategy_overrides · object

Strategy-specific overrides for this attribute

Show child attributes