Update a Credential Type
PUT {{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}
Use the PUT {{apiPath}}/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 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 exists for that credential type, no error occurs. That credential type is simply never issued.
Prerequisites
Create a credential type to get a credentialTypeID for the endpoint. See also PingOne Credentials, especially Credential Types.
See Credential Types data model for full property descriptions.
| Property | Type | Required? |
|---|---|---|
cardDesignTemplate | String | Required |
cardType | String | Optional |
description | String | Optional |
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 |
Disclaimer: The feature supporting multiple is available on a limited basis. Please contact your sales representative for more information.
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 | 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 |
Request Body
{"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"=>"Alphanumeric Text -> First Name", "title"=>"First Name", "isVisible"=>true, "type"=>"Alphanumeric Text", "required"=>false}, {"id"=>"Alphanumeric Text -> Last Name", "title"=>"Last Name", "isVisible"=>true, "type"=>"Alphanumeric Text", "required"=>false}, {"id"=>"Alphanumeric Text -> Address", "title"=>"Address", "isVisible"=>true, "type"=>"Alphanumeric Text", "required"=>false}, {"id"=>"Alphanumeric Text -> Medical Limitations", "title"=>"Medical Limitations", "isVisible"=>true, "type"=>"Alphanumeric Text", "required"=>false}], "version"=>1}, "cardDesignTemplate"=>"<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 740 480\"><g><rect fill=\"none\" width=\"736\" height=\"476\" stroke=\"#808993\" stroke-width=\"3\" rx=\"10\" ry=\"10\" x=\"2\" y=\"2\"></rect><rect fill=\"${cardColor}\" height=\"476\" rx=\"10\" ry=\"10\" width=\"736\" x=\"2\" y=\"2\"></rect><image href=\"${backgroundImage}\" opacity=\"${bgOpacityPercent}\" height=\"476\" rx=\"10\" ry=\"10\" width=\"736\" x=\"2\" y=\"2\"></image><text fill=\"${textColor}\" font-weight=\"450\" font-size=\"30\" x=\"160\" y=\"80\">${cardTitle}</text><text fill=\"${textColor}\" font-size=\"25\" font-weight=\"300\" x=\"160\" y=\"120\">${cardSubtitle}</text><image href=\"${logoImage}\" x=\"42\" y=\"43\" height=\"90px\" width=\"90px\"></image><line xmlns=\"http://www.w3.org/2000/svg\" y2=\"160\" x2=\"695\" y1=\"160\" x1=\"42.5\" stroke=\"#808993\"></line><image href=\"data:image/jpeg;base64,${fields[0].value}\" x=\"42.5\" y=\"180\" rx=\"80px\" ry=\"80px\" height=\"130px\" width=\"130px\"></image><text fill=\"${textColor}\" font-weight=\"500\" font-size=\"20\" x=\"190\" y=\"230\">${fields[1].title}: ${fields[1].value}</text><text fill=\"${textColor}\" font-weight=\"500\" font-size=\"20\" x=\"190\" y=\"272\">${fields[2].title}: ${fields[2].value}</text><text fill=\"${textColor}\" font-weight=\"500\" font-size=\"20\" x=\"190\" y=\"314\">${fields[3].title}: ${fields[3].value}</text></g></svg>", "onDelete"=>{"revokeIssuedCredentials"=>true}}
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialTypes/fdec0a97-5d61-426c-8a38-caffaeb63559"}},"id":"fdec0a97-5d61-426c-8a38-caffaeb63559","createdAt":"2024-03-20T13:08:51.406Z","updatedAt":"2024-03-28T16:27:36.632730246Z","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"issuer":{"id":"824c722c-254a-4b2d-9b50-17e2abdf5f8a"},"management":{"mode":"MANAGED"},"title":"Credential type title","description":"Credential type description","cardType":"Driver License","uri":"https://api.pingone.com/v1/distributedid/credentialTypes/fdec0a97-5d61-426c-8a38-caffaeb63559","version":{"number":3,"uri":"https://api.pingone.com/v1/distributedid/credentialTypes/fdec0a97-5d61-426c-8a38-caffaeb63559/v3"},"metadata":{"name":"Credential type title","description":"Credential type description","textColor":"#000000","cardColor":"#FFFFFF","backgroundImage":"","logoImage":"","bgOpacityPercent":20,"fields":[{"id":"Alphanumeric Text -\u003e Logo","title":"Logo","isVisible":true,"type":"Alphanumeric Text","value":"R0lGODlhIAAgAPEAAAAAAAAAM8wzMwAAACH/C05FVFNDQVBFMi4wAwEAAAAh/jpQaW5neSBQaW5neSBQaW5neSBQaW5neQpQSU5HWSBQSU5HWSBQSU5HWSAKUElOR1lQSU5HWVBJTkdZACH5BAkKAAEALAAAAAAgACAAAAKDjI+py+0Po5wSiIuzFtPufx0Z44GbOCbAyrauG2jLS8OxrAo1zd0pYuHpXJyQw0PMsH6Nkgn30D0vK0xE+lwaowHnprVVhEJejbYnTpXNTAR0DWK8p22U1QD/oOzo7vPG1+dwYjAGxbUQJyHodjgYluD4eJdGYSJmqUgRqbnp+QkaUAAAOw==","required":false},{"id":"Directory Attribute -\u003e Street Address","title":"Street Address","isVisible":true,"type":"Directory Attribute","attribute":"streetAddress","required":true},{"id":"Directory Attribute -\u003e City","title":"City","isVisible":true,"type":"Directory Attribute","attribute":"locality","required":true},{"id":"Directory Attribute -\u003e State","title":"State","isVisible":true,"type":"Directory Attribute","attribute":"region","required":true},{"id":"Directory Attribute -\u003e Zip Code","title":"Zip Code","isVisible":true,"type":"Directory Attribute","attribute":"postalCode","required":true}],"version":5},"cardDesignTemplate":"\u003csvg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 740 480\"\u003e\u003cg\u003e\u003crect fill=\"none\" width=\"736\" height=\"476\" stroke=\"#808993\" stroke-width=\"3\" rx=\"10\" ry=\"10\" x=\"2\" y=\"2\"\u003e\u003c/rect\u003e\u003crect fill=\"${cardColor}\" height=\"476\" rx=\"10\" ry=\"10\" width=\"736\" x=\"2\" y=\"2\"\u003e\u003c/rect\u003e\u003cimage href=\"${backgroundImage}\" opacity=\"${bgOpacityPercent}\" height=\"476\" rx=\"10\" ry=\"10\" width=\"736\" x=\"2\" y=\"2\"\u003e\u003c/image\u003e\u003ctext fill=\"${textColor}\" font-weight=\"450\" font-size=\"30\" x=\"160\" y=\"80\"\u003e${cardTitle}\u003c/text\u003e\u003ctext fill=\"${textColor}\" font-size=\"25\" font-weight=\"300\" x=\"160\" y=\"120\"\u003e${cardSubtitle}\u003c/text\u003e\u003cimage href=\"${logoImage}\" x=\"42\" y=\"43\" height=\"90px\" width=\"90px\"\u003e\u003c/image\u003e\u003cline xmlns=\"http://www.w3.org/2000/svg\" y2=\"160\" x2=\"695\" y1=\"160\" x1=\"42.5\" stroke=\"#808993\"\u003e\u003c/line\u003e\u003ctext fill=\"${textColor}\" font-weight=\"500\" font-size=\"20\" x=\"190\" y=\"230\"\u003e${fields[0].title}: ${fields[0].value}\u003c/text\u003e\u003ctext fill=\"${textColor}\" font-weight=\"500\" font-size=\"20\" x=\"190\" y=\"272\"\u003e${fields[1].title}: ${fields[1].value}\u003c/text\u003e\u003c/g\u003e\u003c/svg\u003e","onDelete":{"revokeIssuedCredentials":false}}