---
title: Agreements Resources
description: 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.
component: pingone-api
page_id: pingone-api:platform:agreement-management/agreements-resources
canonical_url: https://developer.pingidentity.com/pingone-api/platform/agreement-management/agreements-resources.html
section_ids:
  agreements-data-model: Agreements data model
  response-codes: Response codes
---

# Agreements Resources

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.

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

## Agreements data model

| Property                 | Type    | Required? | Mutable?  | Description                                                                                                                                                                                                                                                            |
| ------------------------ | ------- | --------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `consentCountsUpdatedAt` | Date    | N/A       | Read-Only | The time the consent count metric was last updated. This value is typically updated once every 24 hours.                                                                                                                                                               |
| `description`            | String  | Optional  | Mutable   | The description of the agreement.                                                                                                                                                                                                                                      |
| `enabled`                | Boolean | Required  | Mutable   | The current enabled state of the agreement. 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 that it is configured across PingOne. |
| `environment.id`         | String  | N/A       | Read-Only | A string that specifies the environment associated with the agreement.                                                                                                                                                                                                 |
| `expiredUserConsents`    | Integer | Required  | Read-Only | 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`                     | String  | N/A       | Read-Only | The agreement ID.                                                                                                                                                                                                                                                      |
| `name`                   | String  | Required  | Mutable   | The name of the agreement resource.                                                                                                                                                                                                                                    |
| `reconsentPeriodDays`    | Float   | Optional  | Mutable   | The number of days until a consent to this agreement expires.                                                                                                                                                                                                          |
| `totalUserConsents`      | Integer | Required  | Read-Only | 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.                                 |