---
title: Update a Credential Type
description: Use the PUT {{apiPath}}/v1/environments/{{envID}}/credentialTypes/{{credentialTypeID}} operation to update a specific type of credential for issuance. A credential type corresponds to the Card type presented by the compatible wallet app.
component: pingone-api
page_id: pingone-api:credentials:credential-types/update-a-credential-type
canonical_url: https://developer.pingidentity.com/pingone-api/credentials/credential-types/update-a-credential-type.html
section_ids:
prerequisites: Prerequisites
headers: Headers
body: Body
example-request: Example Request
example-response: Example Response
---
# Update a Credential Type
##
```none
PUT {{apiPath}}/v1/environments/{{envID}}/credentialTypes/{{credentialTypeID}}
```
Use the `PUT {{apiPath}}/v1/environments/{{envID}}/credentialTypes/{{credentialTypeID}}` operation to update a specific type of credential for issuance. A credential type corresponds to the Card type presented by the compatible wallet app.
If the updated credential type differs from the existing credential type, the service saves the existing credential type as a Credential Type Version and increments `version.number` in the updated credential type. Credential Type Versions can be read with [Read All Credential Type Versions](read-all-credential-types-versions.html).
If you change `management.mode` from `AUTOMATED` to `MANAGED` and an associated issuance rule exists, the rule is disabled, but not deleted. If you change `management.mode` from `MANAGED` to `AUTOMATED` and no [credential issuance rule](../credential-issuance-rules.html) exists for that credential type, no error occurs. That credential type is simply never issued.
### Prerequisites
[Create a credential type (automated)](create-credential-type-automated.html) or [Create a credential type (managed)](create-credential-type-managed.html) to get a `credentialTypeID` for the endpoint. Refer also to [Credential Types](../credential-types.html).
If `management.mode` is `AUTOMATED`, you can value one and only one of the three properties in the `expiration` object and the associated credential issuance rule automatically assigns an expiration date when it issues the credential. If `management.mode` is `MANAGED` and an `expiration` object is present, it causes an error.
If you want to change `management.mode` from `AUTOMATED` to `MANAGED`, but one of the three properties in the `expiration` object is valued, the body must have no `expiration` object, which removes it from the credential type, and set `management.mode` to `MANAGED`.
> **Collapse: Request Model**
>
> Refer to [Credential Types data model](../credential-types.html#credential-types-data-model) for full property descriptions.
>
> | Property | Type | Required? |
> | ---------------------------------- | -------- | ----------------- |
> | `cardDesignTemplate` (deprecated) | String | Required |
> | `cardType` | String | Optional |
> | `description` | String | Optional |
> | `expiration` | Object | Optional |
> | `expiration.after` | Object | Required/Optional |
> | `expiration.after.duration` | Integer | Required |
> | `expiration.after.timeUnit` | String | Required |
> | `expiration.expression` | String | Required/Optional |
> | `expiration.fieldName` | String | Required/Optional |
> | `expiration.timestamp` | DateTime | Required/Optional |
> | `expiration.type` | String | Required |
> | `issuerName` | String | Optional |
> | `management.mode` | String | Optional |
> | `metadata` | Object | Required |
> | `multiple` | Object | Optional |
> | `multiple.expression` | String | Required |
> | `onDelete.revokeIssuedCredentials` | Boolean | Optional |
> | `title` | String | Required |
> | `version` | String | Optional |
>
> **metadata object data model**
>
> | Property | Type | Required? |
> | ------------------------------- | --------- | ----------------- |
> | `backgroundImage` | String | Optional |
> | `bgOpacityPercent` | String | Optional |
> | `cardColor` | String | Optional |
> | `description` | String | Optional |
> | `fields` | Object\[] | Optional |
> | `fields.attribute` | String | Required/Optional |
> | `fields.fileSupport` | String | Optional |
> | `fields.id` | String | Required |
> | `fields.isVisible` (deprecated) | Boolean | Required |
> | `fields.required` | Boolean | Optional |
> | `fields.title` | String | Required |
> | `fields.type` | String | Required |
> | `fields.values` | String\[] | Required/Optional |
> | `logoImage` | String | Optional |
> | `name` | String | Optional |
> | `textColor` | String | Optional |
> | `version` | String | Optional |
### Headers
Authorization Bearer {{accessToken}}
Content-Type application/json
### Body
raw ( application/json )
```json
{
"title": "Card Developers",
"description": "PingOne Credentials",
"management": {
"mode": "MANAGED"
},
"cardType": "Card Developers",
"metadata": {
"name": "Card Developers",
"description": "PingOne Credentials",
"textColor": "#000000",
"cardColor": "#FFFFFF",
"backgroundImage": "data:image/jpeg;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs=",
"logoImage": "",
"bgOpacityPercent": 20,
"fields": [
{
"id": "Directory Attribute -> Name",
"title": "Name",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "name.formatted",
"required": false
},
{
"id": "Directory Attribute -> Street Address",
"title": "Street Address",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "streetAddress",
"required": true
},
{
"id": "Directory Attribute -> City",
"title": "City",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "locality",
"required": true
},
{
"id": "Directory Attribute -> State",
"title": "State",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "region",
"required": true
},
{
"id": "Directory Attribute -> Zip Code",
"title": "Zip Code",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "postalCode",
"required": true
},
{
"id": "Alphanumeric Text -> Endorsements",
"title": "Endorsements",
"isVisible": true,
"type": "Alphanumeric Text",
"value": "None",
"required": false
}
],
"bgOpacityPercent": 20,
"version": 4
},
"cardDesignTemplate": "",
"onDelete": {
"revokeIssuedCredentials": true
}
}
```
##
### Example Request
* cURL
* C#
* Go
* HTTP
* Java
* jQuery
* NodeJS
* Python
* PHP
* Ruby
* Swift
```shell
curl --location --globoff --request PUT '{{apiPath}}/v1/environments/{{envID}}/credentialTypes/{{credentialTypeID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"title": "Card Developers",
"description": "PingOne Credentials",
"management": {
"mode": "MANAGED"
},
"cardType": "Card Developers",
"metadata": {
"name": "Card Developers",
"description": "PingOne Credentials",
"textColor": "#000000",
"cardColor": "#FFFFFF",
"backgroundImage": "data:image/jpeg;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs=",
"logoImage": "",
"bgOpacityPercent": 20,
"fields": [
{
"id": "Directory Attribute -> Name",
"title": "Name",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "name.formatted",
"required": false
},
{
"id": "Directory Attribute -> Street Address",
"title": "Street Address",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "streetAddress",
"required": true
},
{
"id": "Directory Attribute -> City",
"title": "City",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "locality",
"required": true
},
{
"id": "Directory Attribute -> State",
"title": "State",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "region",
"required": true
},
{
"id": "Directory Attribute -> Zip Code",
"title": "Zip Code",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "postalCode",
"required": true
},
{
"id": "Alphanumeric Text -> Endorsements",
"title": "Endorsements",
"isVisible": true,
"type": "Alphanumeric Text",
"value": "None",
"required": false
}
],
"bgOpacityPercent": 20,
"version": 4
},
"cardDesignTemplate": "",
"onDelete": {
"revokeIssuedCredentials": true
}
}'
```
```csharp
var options = new RestClientOptions("{{apiPath}}/v1/environments/{{envID}}/credentialTypes/{{credentialTypeID}}")
{
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" +
@" ""title"": ""Card Developers""," + "\n" +
@" ""description"": ""PingOne Credentials""," + "\n" +
@" ""management"": {" + "\n" +
@" ""mode"": ""MANAGED""" + "\n" +
@" }," + "\n" +
@" ""cardType"": ""Card Developers""," + "\n" +
@" ""metadata"": {" + "\n" +
@" ""name"": ""Card Developers""," + "\n" +
@" ""description"": ""PingOne Credentials""," + "\n" +
@" ""textColor"": ""#000000""," + "\n" +
@" ""cardColor"": ""#FFFFFF""," + "\n" +
@" ""backgroundImage"": ""data:image/jpeg;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs=""," + "\n" +
@" ""logoImage"": """"," + "\n" +
@" ""bgOpacityPercent"": 20," + "\n" +
@" ""fields"": [" + "\n" +
@" {" + "\n" +
@" ""id"": ""Directory Attribute -> Name""," + "\n" +
@" ""title"": ""Name""," + "\n" +
@" ""isVisible"": true," + "\n" +
@" ""type"": ""Directory Attribute""," + "\n" +
@" ""attribute"": ""name.formatted""," + "\n" +
@" ""required"": false" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""id"": ""Directory Attribute -> Street Address""," + "\n" +
@" ""title"": ""Street Address""," + "\n" +
@" ""isVisible"": true," + "\n" +
@" ""type"": ""Directory Attribute""," + "\n" +
@" ""attribute"": ""streetAddress""," + "\n" +
@" ""required"": true" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""id"": ""Directory Attribute -> City""," + "\n" +
@" ""title"": ""City""," + "\n" +
@" ""isVisible"": true," + "\n" +
@" ""type"": ""Directory Attribute""," + "\n" +
@" ""attribute"": ""locality""," + "\n" +
@" ""required"": true" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""id"": ""Directory Attribute -> State""," + "\n" +
@" ""title"": ""State""," + "\n" +
@" ""isVisible"": true," + "\n" +
@" ""type"": ""Directory Attribute""," + "\n" +
@" ""attribute"": ""region""," + "\n" +
@" ""required"": true" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""id"": ""Directory Attribute -> Zip Code""," + "\n" +
@" ""title"": ""Zip Code""," + "\n" +
@" ""isVisible"": true," + "\n" +
@" ""type"": ""Directory Attribute""," + "\n" +
@" ""attribute"": ""postalCode""," + "\n" +
@" ""required"": true" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""id"": ""Alphanumeric Text -> Endorsements""," + "\n" +
@" ""title"": ""Endorsements""," + "\n" +
@" ""isVisible"": true," + "\n" +
@" ""type"": ""Alphanumeric Text""," + "\n" +
@" ""value"": ""None""," + "\n" +
@" ""required"": false" + "\n" +
@" }" + "\n" +
@" ]," + "\n" +
@" ""bgOpacityPercent"": 20," + "\n" +
@" ""version"": 4" + "\n" +
@" }," + "\n" +
@" ""cardDesignTemplate"": """"," + "\n" +
@" ""onDelete"": {" + "\n" +
@" ""revokeIssuedCredentials"": true" + "\n" +
@" }" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
```
```golang
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{apiPath}}/v1/environments/{{envID}}/credentialTypes/{{credentialTypeID}}"
method := "PUT"
payload := strings.NewReader(`{
"title": "Card Developers",
"description": "PingOne Credentials",
"management": {
"mode": "MANAGED"
},
"cardType": "Card Developers",
"metadata": {
"name": "Card Developers",
"description": "PingOne Credentials",
"textColor": "#000000",
"cardColor": "#FFFFFF",
"backgroundImage": "data:image/jpeg;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs=",
"logoImage": "",
"bgOpacityPercent": 20,
"fields": [
{
"id": "Directory Attribute -> Name",
"title": "Name",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "name.formatted",
"required": false
},
{
"id": "Directory Attribute -> Street Address",
"title": "Street Address",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "streetAddress",
"required": true
},
{
"id": "Directory Attribute -> City",
"title": "City",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "locality",
"required": true
},
{
"id": "Directory Attribute -> State",
"title": "State",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "region",
"required": true
},
{
"id": "Directory Attribute -> Zip Code",
"title": "Zip Code",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "postalCode",
"required": true
},
{
"id": "Alphanumeric Text -> Endorsements",
"title": "Endorsements",
"isVisible": true,
"type": "Alphanumeric Text",
"value": "None",
"required": false
}
],
"bgOpacityPercent": 20,
"version": 4
},
"cardDesignTemplate": "",
"onDelete": {
"revokeIssuedCredentials": true
}
}`)
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))
}
```
```http
PUT /v1/environments/{{envID}}/credentialTypes/{{credentialTypeID}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"title": "Card Developers",
"description": "PingOne Credentials",
"management": {
"mode": "MANAGED"
},
"cardType": "Card Developers",
"metadata": {
"name": "Card Developers",
"description": "PingOne Credentials",
"textColor": "#000000",
"cardColor": "#FFFFFF",
"backgroundImage": "data:image/jpeg;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs=",
"logoImage": "",
"bgOpacityPercent": 20,
"fields": [
{
"id": "Directory Attribute -> Name",
"title": "Name",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "name.formatted",
"required": false
},
{
"id": "Directory Attribute -> Street Address",
"title": "Street Address",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "streetAddress",
"required": true
},
{
"id": "Directory Attribute -> City",
"title": "City",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "locality",
"required": true
},
{
"id": "Directory Attribute -> State",
"title": "State",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "region",
"required": true
},
{
"id": "Directory Attribute -> Zip Code",
"title": "Zip Code",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "postalCode",
"required": true
},
{
"id": "Alphanumeric Text -> Endorsements",
"title": "Endorsements",
"isVisible": true,
"type": "Alphanumeric Text",
"value": "None",
"required": false
}
],
"bgOpacityPercent": 20,
"version": 4
},
"cardDesignTemplate": "",
"onDelete": {
"revokeIssuedCredentials": true
}
}
```
```java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"title\": \"Card Developers\",\n \"description\": \"PingOne Credentials\",\n \"management\": {\n \"mode\": \"MANAGED\"\n },\n \"cardType\": \"Card Developers\",\n \"metadata\": {\n \"name\": \"Card Developers\",\n \"description\": \"PingOne Credentials\",\n \"textColor\": \"#000000\",\n \"cardColor\": \"#FFFFFF\",\n \"backgroundImage\": \"data:image/jpeg;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs=\",\n \"logoImage\": \"\",\n \"bgOpacityPercent\": 20,\n \"fields\": [\n {\n \"id\": \"Directory Attribute -> Name\",\n \"title\": \"Name\",\n \"isVisible\": true,\n \"type\": \"Directory Attribute\",\n \"attribute\": \"name.formatted\",\n \"required\": false\n },\n {\n \"id\": \"Directory Attribute -> Street Address\",\n \"title\": \"Street Address\",\n \"isVisible\": true,\n \"type\": \"Directory Attribute\",\n \"attribute\": \"streetAddress\",\n \"required\": true\n },\n {\n \"id\": \"Directory Attribute -> City\",\n \"title\": \"City\",\n \"isVisible\": true,\n \"type\": \"Directory Attribute\",\n \"attribute\": \"locality\",\n \"required\": true\n },\n {\n \"id\": \"Directory Attribute -> State\",\n \"title\": \"State\",\n \"isVisible\": true,\n \"type\": \"Directory Attribute\",\n \"attribute\": \"region\",\n \"required\": true\n },\n {\n \"id\": \"Directory Attribute -> Zip Code\",\n \"title\": \"Zip Code\",\n \"isVisible\": true,\n \"type\": \"Directory Attribute\",\n \"attribute\": \"postalCode\",\n \"required\": true\n },\n {\n \"id\": \"Alphanumeric Text -> Endorsements\",\n \"title\": \"Endorsements\",\n \"isVisible\": true,\n \"type\": \"Alphanumeric Text\",\n \"value\": \"None\",\n \"required\": false\n }\n ],\n \"bgOpacityPercent\": 20,\n \"version\": 4\n },\n \"cardDesignTemplate\": \"\",\n \"onDelete\": {\n \"revokeIssuedCredentials\": true\n }\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/v1/environments/{{envID}}/credentialTypes/{{credentialTypeID}}")
.method("PUT", body)
.addHeader("Content-Type", "application/json")
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
```
```javascript
var settings = {
"url": "{{apiPath}}/v1/environments/{{envID}}/credentialTypes/{{credentialTypeID}}",
"method": "PUT",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"title": "Card Developers",
"description": "PingOne Credentials",
"management": {
"mode": "MANAGED"
},
"cardType": "Card Developers",
"metadata": {
"name": "Card Developers",
"description": "PingOne Credentials",
"textColor": "#000000",
"cardColor": "#FFFFFF",
"backgroundImage": "data:image/jpeg;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs=",
"logoImage": "",
"bgOpacityPercent": 20,
"fields": [
{
"id": "Directory Attribute -> Name",
"title": "Name",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "name.formatted",
"required": false
},
{
"id": "Directory Attribute -> Street Address",
"title": "Street Address",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "streetAddress",
"required": true
},
{
"id": "Directory Attribute -> City",
"title": "City",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "locality",
"required": true
},
{
"id": "Directory Attribute -> State",
"title": "State",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "region",
"required": true
},
{
"id": "Directory Attribute -> Zip Code",
"title": "Zip Code",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "postalCode",
"required": true
},
{
"id": "Alphanumeric Text -> Endorsements",
"title": "Endorsements",
"isVisible": true,
"type": "Alphanumeric Text",
"value": "None",
"required": false
}
],
"version": 4
},
"cardDesignTemplate": "",
"onDelete": {
"revokeIssuedCredentials": true
}
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
```
```javascript
var request = require('request');
var options = {
'method': 'PUT',
'url': '{{apiPath}}/v1/environments/{{envID}}/credentialTypes/{{credentialTypeID}}',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"title": "Card Developers",
"description": "PingOne Credentials",
"management": {
"mode": "MANAGED"
},
"cardType": "Card Developers",
"metadata": {
"name": "Card Developers",
"description": "PingOne Credentials",
"textColor": "#000000",
"cardColor": "#FFFFFF",
"backgroundImage": "data:image/jpeg;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs=",
"logoImage": "",
"bgOpacityPercent": 20,
"fields": [
{
"id": "Directory Attribute -> Name",
"title": "Name",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "name.formatted",
"required": false
},
{
"id": "Directory Attribute -> Street Address",
"title": "Street Address",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "streetAddress",
"required": true
},
{
"id": "Directory Attribute -> City",
"title": "City",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "locality",
"required": true
},
{
"id": "Directory Attribute -> State",
"title": "State",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "region",
"required": true
},
{
"id": "Directory Attribute -> Zip Code",
"title": "Zip Code",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "postalCode",
"required": true
},
{
"id": "Alphanumeric Text -> Endorsements",
"title": "Endorsements",
"isVisible": true,
"type": "Alphanumeric Text",
"value": "None",
"required": false
}
],
"version": 4
},
"cardDesignTemplate": "",
"onDelete": {
"revokeIssuedCredentials": true
}
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
```
```python
import requests
import json
url = "{{apiPath}}/v1/environments/{{envID}}/credentialTypes/{{credentialTypeID}}"
payload = json.dumps({
"title": "Card Developers",
"description": "PingOne Credentials",
"management": {
"mode": "MANAGED"
},
"cardType": "Card Developers",
"metadata": {
"name": "Card Developers",
"description": "PingOne Credentials",
"textColor": "#000000",
"cardColor": "#FFFFFF",
"backgroundImage": "data:image/jpeg;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs=",
"logoImage": "",
"bgOpacityPercent": 20,
"fields": [
{
"id": "Directory Attribute -> Name",
"title": "Name",
"isVisible": True,
"type": "Directory Attribute",
"attribute": "name.formatted",
"required": False
},
{
"id": "Directory Attribute -> Street Address",
"title": "Street Address",
"isVisible": True,
"type": "Directory Attribute",
"attribute": "streetAddress",
"required": True
},
{
"id": "Directory Attribute -> City",
"title": "City",
"isVisible": True,
"type": "Directory Attribute",
"attribute": "locality",
"required": True
},
{
"id": "Directory Attribute -> State",
"title": "State",
"isVisible": True,
"type": "Directory Attribute",
"attribute": "region",
"required": True
},
{
"id": "Directory Attribute -> Zip Code",
"title": "Zip Code",
"isVisible": True,
"type": "Directory Attribute",
"attribute": "postalCode",
"required": True
},
{
"id": "Alphanumeric Text -> Endorsements",
"title": "Endorsements",
"isVisible": True,
"type": "Alphanumeric Text",
"value": "None",
"required": False
}
],
"version": 4
},
"cardDesignTemplate": "",
"onDelete": {
"revokeIssuedCredentials": True
}
})
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
}
response = requests.request("PUT", url, headers=headers, data=payload)
print(response.text)
```
```php
setUrl('{{apiPath}}/v1/environments/{{envID}}/credentialTypes/{{credentialTypeID}}');
$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 "title": "Card Developers",\n "description": "PingOne Credentials",\n "management": {\n "mode": "MANAGED"\n },\n "cardType": "Card Developers",\n "metadata": {\n "name": "Card Developers",\n "description": "PingOne Credentials",\n "textColor": "#000000",\n "cardColor": "#FFFFFF",\n "backgroundImage": "data:image/jpeg;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs=",\n "logoImage": "",\n "bgOpacityPercent": 20,\n "fields": [\n {\n "id": "Directory Attribute -> Name",\n "title": "Name",\n "isVisible": true,\n "type": "Directory Attribute",\n "attribute": "name.formatted",\n "required": false\n },\n {\n "id": "Directory Attribute -> Street Address",\n "title": "Street Address",\n "isVisible": true,\n "type": "Directory Attribute",\n "attribute": "streetAddress",\n "required": true\n },\n {\n "id": "Directory Attribute -> City",\n "title": "City",\n "isVisible": true,\n "type": "Directory Attribute",\n "attribute": "locality",\n "required": true\n },\n {\n "id": "Directory Attribute -> State",\n "title": "State",\n "isVisible": true,\n "type": "Directory Attribute",\n "attribute": "region",\n "required": true\n },\n {\n "id": "Directory Attribute -> Zip Code",\n "title": "Zip Code",\n "isVisible": true,\n "type": "Directory Attribute",\n "attribute": "postalCode",\n "required": true\n },\n {\n "id": "Alphanumeric Text -> Endorsements",\n "title": "Endorsements",\n "isVisible": true,\n "type": "Alphanumeric Text",\n "value": "None",\n "required": false\n }\n ],\n "bgOpacityPercent": 20,\n "version": 4\n },\n "cardDesignTemplate": "",\n "onDelete": {\n "revokeIssuedCredentials": true\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();
}
```
```ruby
require "uri"
require "json"
require "net/http"
url = URI("{{apiPath}}/v1/environments/{{envID}}/credentialTypes/{{credentialTypeID}}")
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({
"title": "Card Developers",
"description": "PingOne Credentials",
"management": {
"mode": "MANAGED"
},
"cardType": "Card Developers",
"metadata": {
"name": "Card Developers",
"description": "PingOne Credentials",
"textColor": "\#000000",
"cardColor": "\#FFFFFF",
"backgroundImage": "data:image/jpeg;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs=",
"logoImage": "",
"bgOpacityPercent": 20,
"fields": [
{
"id": "Directory Attribute -> Name",
"title": "Name",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "name.formatted",
"required": false
},
{
"id": "Directory Attribute -> Street Address",
"title": "Street Address",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "streetAddress",
"required": true
},
{
"id": "Directory Attribute -> City",
"title": "City",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "locality",
"required": true
},
{
"id": "Directory Attribute -> State",
"title": "State",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "region",
"required": true
},
{
"id": "Directory Attribute -> Zip Code",
"title": "Zip Code",
"isVisible": true,
"type": "Directory Attribute",
"attribute": "postalCode",
"required": true
},
{
"id": "Alphanumeric Text -> Endorsements",
"title": "Endorsements",
"isVisible": true,
"type": "Alphanumeric Text",
"value": "None",
"required": false
}
],
"version": 4
},
"cardDesignTemplate": "",
"onDelete": {
"revokeIssuedCredentials": true
}
})
response = http.request(request)
puts response.read_body
```
```swift
let parameters = "{\n \"title\": \"Card Developers\",\n \"description\": \"PingOne Credentials\",\n \"management\": {\n \"mode\": \"MANAGED\"\n },\n \"cardType\": \"Card Developers\",\n \"metadata\": {\n \"name\": \"Card Developers\",\n \"description\": \"PingOne Credentials\",\n \"textColor\": \"#000000\",\n \"cardColor\": \"#FFFFFF\",\n \"backgroundImage\": \"data:image/jpeg;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs=\",\n \"logoImage\": \"\",\n \"bgOpacityPercent\": 20,\n \"fields\": [\n {\n \"id\": \"Directory Attribute -> Name\",\n \"title\": \"Name\",\n \"isVisible\": true,\n \"type\": \"Directory Attribute\",\n \"attribute\": \"name.formatted\",\n \"required\": false\n },\n {\n \"id\": \"Directory Attribute -> Street Address\",\n \"title\": \"Street Address\",\n \"isVisible\": true,\n \"type\": \"Directory Attribute\",\n \"attribute\": \"streetAddress\",\n \"required\": true\n },\n {\n \"id\": \"Directory Attribute -> City\",\n \"title\": \"City\",\n \"isVisible\": true,\n \"type\": \"Directory Attribute\",\n \"attribute\": \"locality\",\n \"required\": true\n },\n {\n \"id\": \"Directory Attribute -> State\",\n \"title\": \"State\",\n \"isVisible\": true,\n \"type\": \"Directory Attribute\",\n \"attribute\": \"region\",\n \"required\": true\n },\n {\n \"id\": \"Directory Attribute -> Zip Code\",\n \"title\": \"Zip Code\",\n \"isVisible\": true,\n \"type\": \"Directory Attribute\",\n \"attribute\": \"postalCode\",\n \"required\": true\n },\n {\n \"id\": \"Alphanumeric Text -> Endorsements\",\n \"title\": \"Endorsements\",\n \"isVisible\": true,\n \"type\": \"Alphanumeric Text\",\n \"value\": \"None\",\n \"required\": false\n }\n ],\n \"bgOpacityPercent\": 20,\n \"version\": 4\n },\n \"cardDesignTemplate\": \"\",\n \"onDelete\": {\n \"revokeIssuedCredentials\": true\n }\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/v1/environments/{{envID}}/credentialTypes/{{credentialTypeID}}")!,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
```json
{
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialTypes/41fc9049-f742-4d5f-8950-e343ade4a48a"
},
"environment": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"credentialIssuerProfile": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialIssuerProfile"
},
"issuanceRules": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialTypes/41fc9049-f742-4d5f-8950-e343ade4a48a/issuanceRules"
}
},
"id": "41fc9049-f742-4d5f-8950-e343ade4a48a",
"createdAt": "2025-02-28T20:48:10.792Z",
"updatedAt": "2025-02-28T21:03:45.086159649Z",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"issuer": {
"id": "824c722c-254a-4b2d-9b50-17e2abdf5f8a"
},
"management": {
"mode": "AUTOMATED"
},
"title": "Title",
"description": "Subtitle",
"cardType": "Title",
"uri": "https://api.pingone.com/v1/distributedid/credentialTypes/41fc9049-f742-4d5f-8950-e343ade4a48a",
"version": {
"number": 2,
"uri": "https://api.pingone.com/v1/distributedid/credentialTypes/41fc9049-f742-4d5f-8950-e343ade4a48a/v2",
"id": "4638de82-f14b-4665-851c-17bf71cebc22"
},
"metadata": {
"name": "Alphanumeric Text Example",
"description": "Alphanumeric Text Attribute",
"textColor": "#253746",
"cardColor": "#9997bf",
"backgroundImage": "",
"logoImage": "",
"bgOpacityPercent": 20,
"fields": [
{
"id": "Alphanumeric Text -> Account",
"title": "Account",
"isVisible": true,
"type": "Alphanumeric Text",
"value": "Value",
"required": true
},
{
"id": "Alphanumeric Text -> Name",
"title": "Name",
"isVisible": true,
"type": "Alphanumeric Text",
"value": "Value",
"required": true
},
{
"id": "Alphanumeric Text -> Number",
"title": "Number",
"isVisible": true,
"type": "Alphanumeric Text",
"value": "Value",
"required": true
}
],
"version": 4
},
"onDelete": {
"revokeIssuedCredentials": true
},
"visualizationTemplateData": {
"showTitle": true,
"displayFields": [
{
"showFieldName": false,
"dataFieldName": "Account"
},
{
"showFieldName": true,
"dataFieldName": "Name"
}
]
}
}
```