Update Credential Issuance Rule

PUT {{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}/issuanceRules/{{credentialIssuanceRuleID}}

Use the PUT {{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}/issuanceRules/{{credentialIssuanceRuleID}} operation to update a credential issuance rule for the specified credential type in the specified environment.

Prerequisites

• Create a credential type to get a credentialTypeID for the endpoint. See also PingOne Credentials, especially Credential Types.

• Create a credential issuance rule to get a credentialIssuanceRuleID for the endpoint. See also PingOne Credentials, especially Credential Issuance Rules.

See Credential Issuance Rules data model for full property descriptions.

If you change: - filter - The service stages changes to credentials affected. The service issues new credentials to users added by the change to the filter and revokes credentials of users removed by the change to the filter. - automation - The service reviews existing staged changes and either schedules them for the next periodic run (ON_DEMAND to PERIODIC) or de-schedules them (PERIODIC to ON_DEMAND). - digitalWalletApplication.id - Credentials are not affected.

When an action in automation is set to PERIODIC and the period arrives, the credential service uses a notification template appropriate to the action, credential_issued, credential_updated, or credential_revoked, to send notice of the action taken to the user via email or SMS text. The notification.template object can define a variant and locale for the notifications, if needed, and applies to actions initiated periodically and actions initiated by an Apply Credential Issuance Rule Staged Changes request.

Note: The notification.template object applies a variant and locale to all three credential notification templates: credential_issued, credential_updated, and credential_revoked. When adding a variant or locale to any of the three notification templates, consider adding the same variant or locale to the other notification templates. If a matching variant is not defined, the default notification template is used. If a locale is not defined the notification template uses the user's preferred language or, if the user has no preferred language, the default language of the environment.

Request Body

{"status"=>"ACTIVE", "digitalWalletApplication"=>{"id"=>"{{digitalWalletApplicationID}}"}, "filter"=>{"populationIds"=>["{{popID}}"]}, "automation"=>{"issue"=>"ON_DEMAND", "update"=>"ON_DEMAND", "revoke"=>"ON_DEMAND"}}

RESPONSES

status: OK

{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialTypes/8a3a6157-5fb9-40b7-96c0-909331858248/issuanceRules/7888a5ed-ae7b-482c-973d-afd27973099c"}},"id":"7888a5ed-ae7b-482c-973d-afd27973099c","createdAt":"2023-03-01T20:29:51.912Z","updatedAt":"2023-03-02T15:01:48.575Z","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"credentialType":{"id":"8a3a6157-5fb9-40b7-96c0-909331858248"},"status":"ACTIVE","digitalWalletApplication":{"id":"6815c8a6-bc0b-4105-8f37-50f6c35583d7"},"filter":{"populationIds":["e85091a0-ddca-422e-935e-d1faf139df3d"]},"automation":{"issue":"ON_DEMAND","update":"ON_DEMAND","revoke":"ON_DEMAND"}}