The agreements API defines the top level configuration for all the languages resources associated with the agreement. It implements functions to create, read, update, and delete agreement resources.

Agreements data model

Property Description
consentCountsUpdatedAt The time the consent count metric was last updated. This value is typically updated once every 24 hours.
description A string that specifies the description of the agreement.
enabled A boolean that specifies the current enabled state of the agreement. This is a required property. The agreement must support the default language to be enabled. It cannot be disabled if it is referenced by a sign-on action. When an agreement is disabled, it is not used anywhere it is configured across PingOne.
environment.id A string that specifies the environment associated with the agreement.
expiredUserConsents An integer that identifies the number of users who have consented to the agreement, but their consent has expired. This value is last calculated at the consentCountsUpdatedAt time.
id A string that specifies the agreement ID.
name A string that specifies the name of the agreement resource. This is a required property.
reconsentPeriodDays A number that represents the number of days until a consent to this agreement expires.
totalUserConsents An integer that identifies the total number of users who have consented to the agreement. This value is last calculated at the consentCountsUpdatedAt time.

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.