PingOne Platform APIs

Update Credential Issuer Profile

   

PUT {{apiPath}}/environments/{{envId}}/credentialIssuerProfile

An environment can have only one issuer of credentials. Use PUT {{apiPath}}/environments/{{envId}}/credentialIssuerProfile to change any properties of the environment’s credential issuer profile.

Request Model

Refer to Credential Issuers data model for full property descriptions.

Property

Type

Required

credentialSigning

Object

Optional

credentialSigning.headers.<field>

String

Required

credentialSigning.headers

Object

Optional

credentialSigning.url

String

Required

did.method

String

N/A

did.value

String

N/A

did.web.host

String

N/A

did.web.useCustomDomain

Boolean

Optional

logo

Object

Optional

name

String

Required

siteUrl

String

Optional

Note that, in the did object, only .web.useCustomDomain is read and that .method, .value, and .web.host are system-defined and ignored if included.

Prerequisites

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "name": "Credential Signing Issuer",
    "siteUrl": "https://pingidentity.com",
    "credentialSigning": {
        "url": "{{customerCredentialSigningApiUrl}}",
        "headers": {
            "Authorization": "{{customerCredentialSigningApiKey}}"
        }
    }
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff --request PUT '{{apiPath}}/environments/{{envId}}/credentialIssuerProfile' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "name": "Credential Signing Issuer",
    "siteUrl": "https://pingidentity.com",
    "credentialSigning": {
        "url": "{{customerCredentialSigningApiUrl}}",
        "headers": {
            "Authorization": "{{customerCredentialSigningApiKey}}"
        }
    }
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envId}}/credentialIssuerProfile")
{
  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" +
@"    ""name"": ""Credential Signing Issuer""," + "\n" +
@"    ""siteUrl"": ""https://pingidentity.com""," + "\n" +
@"    ""credentialSigning"": {" + "\n" +
@"        ""url"": ""{{customerCredentialSigningApiUrl}}""," + "\n" +
@"        ""headers"": {" + "\n" +
@"            ""Authorization"": ""{{customerCredentialSigningApiKey}}""" + "\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}}/credentialIssuerProfile"
  method := "PUT"

  payload := strings.NewReader(`{
    "name": "Credential Signing Issuer",
    "siteUrl": "https://pingidentity.com",
    "credentialSigning": {
        "url": "{{customerCredentialSigningApiUrl}}",
        "headers": {
            "Authorization": "{{customerCredentialSigningApiKey}}"
        }
    }
}`)

  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}}/credentialIssuerProfile HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "name": "Credential Signing Issuer",
    "siteUrl": "https://pingidentity.com",
    "credentialSigning": {
        "url": "{{customerCredentialSigningApiUrl}}",
        "headers": {
            "Authorization": "{{customerCredentialSigningApiKey}}"
        }
    }
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"name\": \"Credential Signing Issuer\",\n    \"siteUrl\": \"https://pingidentity.com\",\n    \"credentialSigning\": {\n        \"url\": \"{{customerCredentialSigningApiUrl}}\",\n        \"headers\": {\n            \"Authorization\": \"{{customerCredentialSigningApiKey}}\"\n        }\n    }\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envId}}/credentialIssuerProfile")
  .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}}/credentialIssuerProfile",
  "method": "PUT",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "name": "Credential Signing Issuer",
    "siteUrl": "https://pingidentity.com",
    "credentialSigning": {
      "url": "{{customerCredentialSigningApiUrl}}",
      "headers": {
        "Authorization": "{{customerCredentialSigningApiKey}}"
      }
    }
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'PUT',
  'url': '{{apiPath}}/environments/{{envId}}/credentialIssuerProfile',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "name": "Credential Signing Issuer",
    "siteUrl": "https://pingidentity.com",
    "credentialSigning": {
      "url": "{{customerCredentialSigningApiUrl}}",
      "headers": {
        "Authorization": "{{customerCredentialSigningApiKey}}"
      }
    }
  })

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

url = "{{apiPath}}/environments/{{envId}}/credentialIssuerProfile"

payload = json.dumps({
  "name": "Credential Signing Issuer",
  "siteUrl": "https://pingidentity.com",
  "credentialSigning": {
    "url": "{{customerCredentialSigningApiUrl}}",
    "headers": {
      "Authorization": "{{customerCredentialSigningApiKey}}"
    }
  }
})
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}}/credentialIssuerProfile');
$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    "name": "Credential Signing Issuer",\n    "siteUrl": "https://pingidentity.com",\n    "credentialSigning": {\n        "url": "{{customerCredentialSigningApiUrl}}",\n        "headers": {\n            "Authorization": "{{customerCredentialSigningApiKey}}"\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}}/credentialIssuerProfile")

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({
  "name": "Credential Signing Issuer",
  "siteUrl": "https://pingidentity.com",
  "credentialSigning": {
    "url": "{{customerCredentialSigningApiUrl}}",
    "headers": {
      "Authorization": "{{customerCredentialSigningApiKey}}"
    }
  }
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"name\": \"Credential Signing Issuer\",\n    \"siteUrl\": \"https://pingidentity.com\",\n    \"credentialSigning\": {\n        \"url\": \"{{customerCredentialSigningApiUrl}}\",\n        \"headers\": {\n            \"Authorization\": \"{{customerCredentialSigningApiKey}}\"\n        }\n    }\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envId}}/credentialIssuerProfile")!,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

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialIssuerProfile"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "credentialSigningKeys": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialSigningKeys"
        }
    },
    "id": "43b3e256-8bcd-4eae-bbd8-48471bb1014e",
    "createdAt": "2025-04-02T15:11:03.544Z",
    "updatedAt": "2025-11-07T21:02:05.700428818Z",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "applicationInstance": {
        "id": "15b90694-f574-4bbc-be68-db937abe4556"
    },
    "name": "Secure Issuer",
    "siteUrl": "https://pingidentity1.com",
    "did": {
        "method": "WEBVH",
        "value": "did:webvh:QmRk4NCNGCVgTAoBAMhtTPFiZYRvYL6N2NxNKV5bqGSw8U:auth.pingone.com:abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6",
        "web": {
            "host": "PING",
            "useCustomDomain": true
        }
    }
}

Example Response

200 OK

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialIssuerProfile"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "credentialSigningKeys": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialSigningKeys"
        }
    },
    "id": "913c21bb-0570-426b-97c4-e4d56e8861a5",
    "createdAt": "2021-12-07T18:13:50.853Z",
    "updatedAt": "2025-07-07T15:29:24.260425980Z",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "applicationInstance": {
        "id": "a00b4f81-3e3b-4343-a3ac-ee40e635f464"
    },
    "name": "Credential Signing Issuer",
    "siteUrl": "https://pingidentity.com"
}