> For the complete documentation index, see [llms.txt](https://learn.netmaker.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://learn.netmaker.io/getting-started/about/how-it-works/4.-grant-user-access.md).

# 4. Grant User Access

Add users to platform, set access and permissions

### Overview

Users access the VPN using the Desktop and Mobile Apps, on-demand VPN clients that can run on Windows, Mac, Linux, iPhone, and Android. Users can authenticate via Basic Auth or OAuth, and can be segmented into groups to separate access.

![](/files/03e2236f4a4df2b6a216032e994a410100fe7c6b)

Setting up user access consists of three steps:

{% stepper %}
{% step %}

### Add Users

Users can be Created, Invited, or can Sign-Up (Pending Users).

For all these options, it is important to know the basic Access Level you want to assign:

**Admin:** Has access to all resources on the platform

**Platform User:** Will have access to specified resources on the platform

**Service User:** Will only have the ability to use the VPN via App (cannot log into the platform).

For this guide we are assuming you are configuring Service Users.

#### Create Users (basic auth)

Click on  “Create User” in User Management interface to create a new Basic Auth user. Set a username, password, and specify the access level.

<figure><img src="/files/GNHsFLCdvdmgY1pDDR32" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Set User Permissions

#### Invite Users

Click on  “Invite User” in User Management interface to invite new users by email. If OAuth is configured (or using SaaS) this should be a compatible email domain.

<figure><img src="/files/0xoBcSBAxpVOOSpbizdx" alt=""><figcaption></figcaption></figure>

#### Groups

User Groups let you organize members and manage network access at scale. Assign a group to one or more networks with a specific role in each network, and every member inherits those permissions automatically.

<figure><img src="/files/n2Ju97xc2jBGHZSKUkeP" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Secure Remote Access

Once users are added to the platform and permissions configured, they can download and install the Netmaker Desktop and log in to access the network.

**Install the Netmaker Desktop**

<figure><img src="/files/myjt3bGo3r5PcJh6CEOj" alt=""><figcaption></figcaption></figure>

To install the Netmaker Desktop, users should download the platform-specific installer at <https://www.netmaker.io/download>. They should then follow the platform-specific instructions to install the client.

**Logging In**

**Server:** Users will need to know the Tenant ID for SaaS Netmaker instances, or API URL for On-Prem:&#x20;

* Tenant ID: The SaaS Tenant ID
* Netmaker API URL: api.\<your netmaker base domain>

Users will then login via Basic Auth or OAuth depending on how they were added:

* **Basic Authentication: Enter Username and Password, click Log In**
* **OAuth: Click the “Login with SSO button and then go through the provider’s login process.**

<br>

<figure><img src="/files/oyOJoSZ5bRwbYPlTVNMP" alt=""><figcaption></figcaption></figure>

Upon successful login, the user will see the gateways for which they have access.

Use the toggle switch to connect or disconnect from a specific gateway and access the network.<br>

{% endstep %}
{% endstepper %}

<figure><img src="/files/bCUEEdHb3XPi2CQrI5Ok" alt=""><figcaption></figcaption></figure>


---

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

```
GET https://learn.netmaker.io/getting-started/about/how-it-works/4.-grant-user-access.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.