Apply Credential Issuance Rule Staged Changes
POST {{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}/issuanceRules/{{credentialIssuanceRuleID}}/stagedChanges
Use the POST {{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}/issuanceRules/{{credentialIssuanceRuleID}}/stagedChanges operation to apply the changes staged by the specified credential issuance rule for the specified credential type in the specified environment.
If an action is set to PERIODIC and the service has not yet reached the end of the period, this operation performs staged changes for actions set to PERIODIC and for actions set to ON_DEMAND. The reverse is not true. If an action is set to ON_DEMAND, you must use this operation to perform staged changes for those actions.
The first example shows the response to a request with a body identifying specific actions. The second example shows the response to a request without a request body.
For each staged credential, 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 using notification templates defined in Create Credential Issuance Rule or Update Credential Issuance Rule.
Prerequisites
Create a credential type to get a
credentialTypeIDfor the endpoint. See also PingOne Credentials, especially Credential Types.Create a credential issuance rule to get a
credentialIssuanceRuleIDfor the endpoint. See also PingOne Credentials, especially Credential Issuance Rules.
See Credential Issuance Rules staged changes data model for full property descriptions.
| Property | Type | Required? |
|---|---|---|
issue | String[] | Optional |
revoke | String[] | Optional |
update | String[] | Optional |
Request Body
{"revoke"=>["{{userID}}", "{{userID_2}}"]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"issued":[{"user":{"id":"10e01013-5c58-4eb1-8073-d814c274c6dd"},"credential":{"id":"0d6a032c-a5e7-471a-89a4-14ce5497b9ee"},"createdAt":"2023-06-01T20:20:07.495Z"}],"errors":[{"environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"credentialType":{"id":"ac39e146-622a-4956-b04e-44d6ea73114c"},"issuanceRule":{"id":"2efb66cc-67c5-4589-9c25-8d13b693a6ff"},"user":{"id":"1b7837ff-c8d2-42f9-94b4-acfa0aedcb61"},"action":"ISSUE","scheduled":false,"errors":[{"recordedAt":"2023-06-01T20:20:07.828Z","errorDetail":{"code":"FILE_RESOLUTION_ERROR","target":"image","message":"File exceeds max file size restriction. File size: 29,638,516 bytes. Maximum size: 2,097,152 bytes."}}],"id":"35835133-af17-4770-8891-21e9bc7e6d9e","createdAt":"2023-06-01T20:19:33.803Z","updatedAt":"2023-06-01T20:20:07.828Z"}]}