> 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 %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.sudoplatform.com/guides/virtual-private-network/vpn-entitlements.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.