CData Python Connector for PingOne

Build 25.0.9454

Agreements

The agreements in the environment.

View-Specific Information

SELECT

Reading data from this entity requires Read Agreement/agreements:read:agreement permission.

We recommend using the built-in Environment Admin role.

The connector uses the PingOne Platform API to process WHERE clause conditions built with the following columns and operators.

  • Id supports the following operators: =, IN.

All other filters are processed client-side within the connector.

For example, the following queries are processed server-side:

SELECT * FROM Administrators.Agreements WHERE Id = 'c908f1ac-745a-4399-aee6-7644a45a07de';
SELECT * FROM Administrators.Agreements WHERE Id IN ('c908f1ac-745a-4399-aee6-7644a45a07de', 'bb9b2f76-94bb-42a3-9945-50fa8be3fdf5');

Columns

Name Type References Description
Id [KEY] String The agreement identifier (UUID).
Name String The name of the agreement.
Description String The agreement's description.
IsEnabled Boolean Boolean value indicating whether the agreement is enabled or not.
ReconsentAfter Integer The number of days until a consent to this agreement expires at which point, the agreement must be consented again.
TotalConsents Integer The total number of agreement consents.
TotalConsentsLastUpdatedAt Datetime The time the consent count metric ('TotalConsents' column) was last updated.
ExpiredConsents Integer The total number of agreement consents that have expired.
EnvironmentId String Information.Environments.Id The identifier (UUID) of the environment in which the agreement exists.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454