> For the complete documentation index, see [llms.txt](https://docs.sudoplatform.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sudoplatform.com/guides/virtual-private-network/vpn-entitlements.md).

# VPN Entitlements

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

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

{% hint style="info" %}
Read more about the Sudo Platform entitlements system and how to integrate with it in the [Entitlements](/guides/entitlements.md) section of the Sudo Platform documentation.
{% endhint %}

The following table describes the entitlement used to control access to the VPN service:

| Entitlement                        | Description                                                           |
| ---------------------------------- | --------------------------------------------------------------------- |
| `sudoplatform.vpn.vpnUserEntitled` | Whether or not user is entitled to use the Sudo Platform VPN service. |

## 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.

{% hint style="info" %}
Read more about the `getEntitlementsConsumptionAPI` available in the Entitlements SDK user API [here](/guides/entitlements/end-user-api/retrieving-entitlements.md#getentitlementsconsumption).
{% endhint %}