Update SAML entity

2 minute read

PUT https://www.digicert.com/services/v2/account/saml-entity/{{entity_id}}

Use this endpoint to update SAML entity settings.

Note

To find the entity_id, use the SAML entity details endpoint.

Example requests and responses

curl -X PUT \
  'https://www.digicert.com/services/v2/account/saml-entity/{{entity_id}}' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}' \
  -d '{
  "source_url": "{{idp_metadata_url}}",
  "attribute_mapping": "{\"username\":\"NameID\"}",
  "friendly_name": "Your Company, Inc."
}'

import requests

url = "https://www.digicert.com/services/v2/account/saml-entity/{{entity_id}}"

payload = "{\n  \"source_url\": \"{{idp_metadata_url}}\",\n  \"attribute_mapping\": \"{\\\"username\\\":\\\"NameID\\\"}\",\n  \"friendly_name\": \"Your Company, Inc.\"\n}"
headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json"
    }

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

print(response.text)

package main

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

func main() {

	url := "https://www.digicert.com/services/v2/account/saml-entity/{{entity_id}}"

	payload := strings.NewReader("{\n  \"source_url\": \"{{idp_metadata_url}}\",\n  \"attribute_mapping\": \"{\\\"username\\\":\\\"NameID\\\"}\",\n  \"friendly_name\": \"Your Company, Inc.\"\n}")

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

	req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}

var request = require("request");

var options = { method: 'PUT',
  url: 'https://www.digicert.com/services/v2/account/saml-entity/{{entity_id}}',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' },
  body: 
   { source_url: '{{idp_metadata_url}}',
     attribute_mapping: '{"username":"NameID"}',
     friendly_name: 'Your Company, Inc.' },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

204 No Content

// empty

Important

A friendly_name_in_use error is returned if the sent friendly_name value is already in use.

Request parameters

Name	Req/Opt	Type	Description
xml_metadata	conditional	string	SAML entity XML metadata. Required only if not using source_url.
source_url	conditional	string	URL used to obtain SAML entity XML metadata. Required only if not using xml_metadata
attribute_mapping	required	string	Attribute used to map CertCentral users to SAML SSO users. Format:
{“username”: “{{attr_name}}”}
friendly_name	required	string	Display name used for the Federation Name and to generate the slug for the SSO sign on URL.