# StarRez

{% hint style="info" %}
This is a Beta feature only for partners and customer with access to the Beta Program
{% endhint %}

**StarRez** integration allows guests to self-onboard simply using their email address via the WiFi portal. If the email is linked to an active resident in StarRez, they receive a magic link granting access to the WiFi Portal where they can retrieve WiFi access details.

### Get started with your connector <a href="#get-started-with-your-connector" id="get-started-with-your-connector"></a>

Get your REST API Connection Settings:

1. Log in to StarRez and click on **Account** in the top left > Account

2. **Web Service** **Tokens** > **Create New**\
   \
   ![](https://3426155342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDvdioCJduzKTpzAv3Sij%2Fuploads%2FVxPVGJg5Vch0f5jBGmSE%2Fimage.png?alt=media\&token=e74bcd76-c1c6-4176-b2e5-4dd1139c2d72)<br>

3. Enter a Name/description for the Token and set the **Expiry Date**. Make sure you copy the token from this screen. It cannot be viewed after you close this window and is not recoverable. \
   \
   ![](https://3426155342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDvdioCJduzKTpzAv3Sij%2Fuploads%2FiFLYB5Hg1jTW0nrEtllK%2Fimage.png?alt=media\&token=e0af48a3-75c7-4358-8504-552bb4ee4f9f)<br>

4. Refer to the API documentation to find your **Rest API URL** (<https://support.starrez.com/hc/en-us/articles/360056850292-StarRez-REST-2-0-Web-Services-API-Guide>)\
   Your StarRez system is usually hosted on a URL such as  format `https://yourinstitution.starrezhousing.com` or similar.\
   The REST API services typically reside under a `/StarRezREST` path, so the Rest API URL could be something like:

   `https://yourinstitution.starrezhousing.com/StarRezREST`

5. Keep a record of these credentials and the RestAPI URL

### Setting up Cusna

Go to Integrations and click **New** in the Integration card, then select **StarRez**.

Enter the following data:

* **RestAPI URL**
* **Access token**
* **CheckOut Report Name** (optional):

  This is a custom report name that allows Cusna to retrieve daily the list of users who have checked out, in order to suspend their WiFi service.

<figure><img src="https://3426155342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDvdioCJduzKTpzAv3Sij%2Fuploads%2FKI0SF1bKRIcVJn2pUjd1%2Fimage.png?alt=media&#x26;token=09370e7c-f6c3-45ef-ab55-2dc59fe7a4e9" alt=""><figcaption></figcaption></figure>

Click **Setup**.

{% hint style="info" %}
If the data provided is not correct, either the URL or the Access Token, you'll receive an error notification
{% endhint %}

### Enabling StarRez

In order to enable StarRez to let user register on the WiFi Portal, go to **Setup**, **Onboarding** and  enable on StarRez on the **Access Control** section.

<figure><img src="https://3426155342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDvdioCJduzKTpzAv3Sij%2Fuploads%2Fy8YExo35mHgiIw8PBYED%2Fimage.png?alt=media&#x26;token=23bba665-fafe-43ca-9e0f-4e2d32cddfc7" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: 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://docs.cusna.io/cloud-identity-platforms-integrations/property-management-systems/starrez.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.