Privacy Interaction Entitlements

The Sudo Platform entitlements system is used to control consumption of Sudo Platform resources and the Privacy Interaction service integrates with this system.

Access to the Privacy Interaction service is controlled at the user level and users are either entitled to use the capability or they are not.

Read more about the Sudo Platform entitlements system and how to integrate with it in the Entitlements section of the Sudo Platform documentation.

The following table describes the entitlements used to control access to the Privacy Interaction service:

Entitlement	Description
sudoplatform.privacy-interaction.serviceUserEntitled	Whether or not user is entitled to use the Sudo Platform Privacy Interaction service.
sudoplatform.privacy-interaction.virtualPresenceMaxPerUser	The maximum number of active virtual presences per user.
sudoplatform.privacy-interaction.gmailDataHolderDiscoveryRate	The number of gmail virtual presence scans per month that a user may execute.

Retrieving Entitlements Information

To determine whether a user is entitled or whether they have consumed that entitlement, call the getEntitlementsConsumption API in the Entitlements SDK. This will return an EntitlementsConsumption object that specifies both the user's entitlements level across all entitled Sudo Platform services and how much of each entitlement has been consumed.

Read more about the getEntitlementsConsumptionAPI available in the Entitlements SDK user API here.