Update a User Credential

PUT {{apiPath}}/environments/{{envID}}/users/{{userID}}/credentials/{{credentialID}}

Use the PUT {{apiPath}}/environments/{{envID}}/users/{{userID}}/credentials/{{credentialID}} request to add or modify a field value in the specified user credential.

Prerequisites

See User Credentials data model for full property descriptions.

PropertyTypeRequired
credentialType.idStringRequired
dataObjectOptional
data.<field>StringRequired/Optional
notificationObjectOptional
notification.templateObjectOptional
notification.template.localeStringRequired
notification.template.variantStringRequired
notification.template.variablesObject[]Required/Optional

All data must be provided in the data object. Anything not included will default to null and any missing required fields cause an error.

After receipt of this request, if the optional notification object is present, the credential service uses the credential_updated notification template to send notice of the update to the user via email or SMS text. The notification.template object can define a variant and locale for the notifications, if needed.

Request Body

{"expiresAt"=>"2024-01-01T00:00:00.000Z"}

RESPONSES

status: OK

{&quot;_links&quot;:{&quot;self&quot;:{&quot;href&quot;:&quot;https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/39b4548e-e71e-4a8b-9a3d-d668a8f8e0ba/credentials/5d5751ae-e21b-4226-b1e8-1bf02127a093&quot;}},&quot;id&quot;:&quot;5d5751ae-e21b-4226-b1e8-1bf02127a093&quot;,&quot;createdAt&quot;:&quot;2023-03-15T13:01:50.207Z&quot;,&quot;updatedAt&quot;:&quot;2023-03-15T13:15:44.717Z&quot;,&quot;environment&quot;:{&quot;id&quot;:&quot;abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6&quot;},&quot;user&quot;:{&quot;id&quot;:&quot;39b4548e-e71e-4a8b-9a3d-d668a8f8e0ba&quot;},&quot;credentialType&quot;:{&quot;id&quot;:&quot;6d20e9c2-9102-42d1-a1fc-74eed31d65d8&quot;},&quot;title&quot;:&quot;Wallet Developers&quot;,&quot;status&quot;:&quot;REVOKED&quot;,&quot;expiresAt&quot;:&quot;2024-01-01T00:00:00Z&quot;}