# Guest Service

# Overview

The Guest Service REST API provides comprehensive management capabilities for guest access in RUCKUS Cloud WiFi environments.

## Key Features

- **Guest User Management**: Create, retrieve, update, and delete guest users with configurable access credentials and expiration policies
- **Portal Service Profiles**: Configure and manage captive portal settings, authentication methods, and user experience
- **Service Templates**: Define reusable templates to streamline portal deployment across multiple networks

This API enables network administrators to efficiently provision temporary network access for guests while maintaining security and control over their wireless infrastructure.


Version: 1.7.1
License: RUCKUS Cloud Privacy Policy

## Servers

RUCKUS One API host for Asian region.
```
https://api.asia.ruckus.cloud
```

RUCKUS One API host for European region.
```
https://api.eu.ruckus.cloud
```

RUCKUS One API host for North American region.
```
https://api.ruckus.cloud
```

## Download OpenAPI description

[Guest Service](https://docs.ruckus.cloud/_bundle/api/guest-1.7.1.yaml)

## Guest User

Manage guest users and their access credentials.

### Guest User Action

 - [PATCH /wifiNetworks/{wifiNetworkId}/guestUsers](https://docs.ruckus.cloud/api/guest-1.7.1/guest-user/actionbyguestuseridandwifinetworkid.md): Guest user action for the guest user.

### Add Guest User

 - [POST /wifiNetworks/{wifiNetworkId}/guestUsers](https://docs.ruckus.cloud/api/guest-1.7.1/guest-user/addguestuser_1.md): Create a new guest user.

### Remove Guest User by ID

 - [DELETE /wifiNetworks/{wifiNetworkId}/guestUsers/{guestUserId}](https://docs.ruckus.cloud/api/guest-1.7.1/guest-user/deleteguestuserbyidandwifinetworkid.md): Remove a guest user.

### Retrieve Guest User by ID

 - [GET /wifiNetworks/{wifiNetworkId}/guestUsers/{guestUserId}](https://docs.ruckus.cloud/api/guest-1.7.1/guest-user/getguestuserbyidandwifinetworkid.md): Retrieve a guest user.

### Update Guest User

 - [PATCH /wifiNetworks/{wifiNetworkId}/guestUsers/{guestUserId}](https://docs.ruckus.cloud/api/guest-1.7.1/guest-user/updatebyguestuseridandwifinetworkid.md): Update guest user enable/disable status or create new password for the guest user.

## Portal Service Profile

Manage portal service profile.

### Add Portal Service Profile

 - [POST /portalServiceProfiles](https://docs.ruckus.cloud/api/guest-1.7.1/portal-service-profile/addportalserviceprofile_1_1.md): Provision one portal service profile as defined in the payload.

### Remove Portal Service Profile

 - [DELETE /portalServiceProfiles/{portalServiceProfileId}](https://docs.ruckus.cloud/api/guest-1.7.1/portal-service-profile/deleteportalserviceprofilebyid.md): Remove portal service profile by id.

### Retrieve Portal Service Profile

 - [GET /portalServiceProfiles/{portalServiceProfileId}](https://docs.ruckus.cloud/api/guest-1.7.1/portal-service-profile/getportalserviceprofilebyid_1_1.md): Retrieve a portal service profile.

### Update Portal Service Profile

 - [PUT /portalServiceProfiles/{portalServiceProfileId}](https://docs.ruckus.cloud/api/guest-1.7.1/portal-service-profile/updateportalserviceprofilebyid_1_1.md): Update portal service profile by id.

### Update Portal Profile Background Image

 - [PUT /portalServiceProfiles/{portalServiceProfileId}/backgroundImages](https://docs.ruckus.cloud/api/guest-1.7.1/portal-service-profile/updateportalserviceprofilebackgroundimage.md): Update portal service profile background image by id.

### Update Portal Profile Logo

 - [PUT /portalServiceProfiles/{portalServiceProfileId}/logos](https://docs.ruckus.cloud/api/guest-1.7.1/portal-service-profile/updateportalserviceprofilelogo.md): Update portal service profile logo by id.

### Update Portal Service Profile Photo

 - [PUT /portalServiceProfiles/{portalServiceProfileId}/photos](https://docs.ruckus.cloud/api/guest-1.7.1/portal-service-profile/updateportalserviceprofilephoto.md): Update portal service profile photo by id.

### Update Portal Profile Powered Image

 - [PUT /portalServiceProfiles/{portalServiceProfileId}/poweredImages](https://docs.ruckus.cloud/api/guest-1.7.1/portal-service-profile/updateportalserviceprofilepoweredimage.md): Update portal service profile powered image by id.

## Portal Service Template

Manage portal service profile template. Use /rec/templates for REC templates.

### Add Portal Service Profile Template

 - [POST /templates/portalServiceProfiles](https://docs.ruckus.cloud/api/guest-1.7.1/portal-service-template/addportalserviceprofiletemplate.md): Add a portal service profile template.

### Remove Portal Service Profile Template

 - [DELETE /templates/portalServiceProfiles/{portalServiceProfileId}](https://docs.ruckus.cloud/api/guest-1.7.1/portal-service-template/deleteportalserviceprofiletemplatebyid.md): Remove a portal service profile template by id.

### Retrieve Portal Service Profile Template

 - [GET /templates/portalServiceProfiles/{portalServiceProfileId}](https://docs.ruckus.cloud/api/guest-1.7.1/portal-service-template/getportalserviceprofiletemplatebyidv1_1.md): Retrieve a portal service profile template by id.

### Update Portal Service Profile Template

 - [PUT /templates/portalServiceProfiles/{portalServiceProfileId}](https://docs.ruckus.cloud/api/guest-1.7.1/portal-service-template/updateportalserviceprofiletemplatev1_1.md): Update portal service profile template by id.

### Update Portal Template Background

 - [PUT /templates/portalServiceProfiles/{portalServiceProfileId}/backgroundImages](https://docs.ruckus.cloud/api/guest-1.7.1/portal-service-template/updateportalserviceprofilebackgroundimagetemplate.md): Update portal service profile template background image by id.

### Update Portal Template Logo

 - [PUT /templates/portalServiceProfiles/{portalServiceProfileId}/logos](https://docs.ruckus.cloud/api/guest-1.7.1/portal-service-template/updateportalserviceprofilelogotemplate.md): Update portal service profile template logo by id.

### Update Portal Template Photo

 - [PUT /templates/portalServiceProfiles/{portalServiceProfileId}/photos](https://docs.ruckus.cloud/api/guest-1.7.1/portal-service-template/updateportalserviceprofilephototemplate.md): Update portal service profile template photo by id.

### Update Portal Template Powered Image

 - [PUT /templates/portalServiceProfiles/{portalServiceProfileId}/poweredImages](https://docs.ruckus.cloud/api/guest-1.7.1/portal-service-template/updateportalserviceprofilepoweredimagetemplate.md): Update portal service profile template powered image by id.