PingOne Platform APIs

Agreement Revisions Resources

Agreement revisions define the specific version text (the agreement content) to manage the lifecycle of the agreement to which users provide consent.

A revision resource allows you to update the content for an agreement language. (A language can have up to 100 associated revisions.) The revision must have a value specified for the effectiveDate property, and when showing content to a user for an agreement language, the content associated with a revision with an effective date closest to the current date is shown. The revision can be configured to force the user to consent again to the agreement.

The revisions service implements functions to create, read, and delete agreement revision resources. Agreement revision resources cannot be updated. If an agreement revision needs to be updated, a new agreement revision should be created. In addition, agreement revision resources that have become effective cannot be deleted, which ensures that consent data is preserved.

You need the Environment Admin role to perform operations on agreement revisions resources.

Revision data model

Property Type Required? Mutable? Description

agreement

String

Required

Read-Only

The UUID for the agreement resource for this revision.

contentType

String

Required

Immutable

The content type of text. Options are text/html and text/plain, as defined by rfc-6838 and Media Types/text. This attribute is supported in POST requests only.

effectiveAt

Date

Required

Mutable

The start date that the revision is presented to users. This property value can be modified only if the current value is a date that has not already passed. The effective date must be unique for each language agreement, and the property value can be the present date or a future date only.

id

String

Required

Read-Only

The revision ID.

language

String

Required

Mutable

A UUID that specifies the language resource associated with this revision.

notValidAfter

Date

Optional

Read-Only

Specifies whether the revision is still valid in the context of all revisions for a language. This property is calculated dynamically at read time, taking into consideration the agreement language, the language enabled property, and the agreement enabled property. When a new revision is added, the notValidAfter property values for all other previous revisions might be impacted. For example, if a new revision becomes effective and it forces reconsent, then all older revisions are no longer valid.

requiresReconsent

Boolean

Required

Mutable

Whether the user is required to provide consent to the language revision after it becomes effective.

text

String

Required

Immutable

Text or HTML for the revision. HTML support includes:

* tags - italicize, bold, links, headers, paragraph, line breaks

* link (a) tags - allow href, style, target attributes

* block tags (p, b, h) - allow style and align attributes

This attribute is supported in POST requests only. For more information, refer to contentType.

Response codes

Code Message

200

Successful operation.

201

Successfully created.

204

Successfully removed. No content.

400

The request could not be completed.

401

You do not have access to this resource.

403

You do not have permissions or are not licensed to make this request.

404

The requested resource was not found.
Related topics