Skip to content
Guest Service/
/
Guest User Action

Guest Service (1.7.1)

https://support.ruckuswireless.com/ruckus-cloud-wifi-legal-terms-and-conditions

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.

Download OpenAPI description
Download PDF
Overview
License
RUCKUS Cloud Privacy Policy
Languages
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

Guest User

Manage guest users and their access credentials.

Operations

Guest User Action

Request

Guest user action for the guest user.

Path
wifiNetworkIdstringrequired
Body
required
actionstringrequired

Action for guest user.

Value"passwordValidation"
Example: "passwordValidation"
passwordstring[ 6 .. 16 ] characters

Manual password. The password must contain at least 6 characters (up to 16). The following characters are permitted: lowercase and uppercase letters, 0-9, and other special characters !@#$%^&*()[]{}-_+=~`|:;"'<>,./?.

{
  "action": "passwordValidation",
  "password": "string"
}

Responses

OK

Body
requestIdstring

Unique identifier that can be used to trace the request status in the activity service.

Response
{
  "requestId": "string"
}

Add Guest User

Request

Create a new guest user.

Path
wifiNetworkIdstringnon-emptyrequired

Network ID of the guest network to which the guest user will connect.

Query
expiration.activationTypestringrequired

When activation type is set to creation, the guest pass is valid when it's created until the specified expiration duration, even if it's not being used; when set to login, the guest pass is valid starting from when the user first logs on until the specified expiration duration.

Enum"Creation""Login"
expiration.durationinteger(int32)[ 1 .. 8760 ]required
expiration.unitstringrequired
Enum"Minute""Hour""Day""Week""Month""Year""Never"
maxDevicesinteger(int32)required

Maximum number of devices the guest user can simultaneously connect to the guest network. If set to -1, no limit is enforced.

Default 3
deliveryMethodsArray of stringsunique

At least one delivery method.

Items Enum"MAIL""SMS""WHATSAPP""STUB""PRINT"
Body
required
deliveryMethodsArray of stringsuniquerequired

At least one delivery method.

Items Enum"MAIL""SMS""WHATSAPP""STUB""PRINT"
disabledboolean

If true, this guest user will not be permitted to join the guest network.

Example: false
emailstring(email)

Email address of the guest user.

expirationobject(GuestUserExpiration)required

Expiration configuration for the guest user account.

expiration.​activationTypestringrequired

When activation type is set to creation, the guest pass is valid when it's created until the specified expiration duration, even if it's not being used; when set to login, the guest pass is valid starting from when the user first logs on until the specified expiration duration.

Enum"Creation""Login"
expiration.​durationinteger(int32)

Duration value for the expiration period.

expiration.​unitstring

Time unit for the expiration duration.

Enum"Minute""Hour""Day""Week""Month""Year""Never"
maxDevicesinteger(int32)required

Maximum number of devices the guest user can simultaneously connect to the guest network. If set to minus one, no limit is enforced.

Example: 3
mobilePhoneNumberstringrequired

The mobile phone number associated to the guest user.

namestringrequired

The name assigned to the guest user.

notesstring[ 0 .. 180 ] characters

Additional notes or comments about the guest user.

{
  "deliveryMethods": [
    "MAIL"
  ],
  "disabled": false,
  "email": "user@example.com",
  "expiration": {
    "activationType": "Creation",
    "duration": 0,
    "unit": "Minute"
  },
  "maxDevices": 3,
  "mobilePhoneNumber": "string",
  "name": "string",
  "notes": "string"
}

Responses

Created

Body
requestIdstring

Unique identifier that can be used to trace the request status in the activity service.

responseobject(GuestUserV1)

The response payload from the operation.

Response
{
  "requestId": "string",
  "response": {
    "createdDate": 0,
    "deliveryMethods": [ … ],
    "disabled": false,
    "email": "user@example.com",
    "expiration": { … },
    "expirationDate": 0,
    "guestUserType": "GuestPass",
    "id": "string",
    "lastModified": 0,
    "macAddresses": [ … ],
    "maxDevices": 3,
    "mobilePhoneNumber": "string",
    "name": "string",
    "notes": "string",
    "password": "string",
    "ssid": "string"
  }
}

Remove Guest User by ID

Request

Remove a guest user.

Path
wifiNetworkIdstringrequired
guestUserIdstringrequired
No request payload

Responses

OK

Body
requestIdstring

Unique identifier that can be used to trace the request status in the activity service.

Response
{
  "requestId": "string"
}

Retrieve Guest User by ID

Request

Retrieve a guest user.

Path
wifiNetworkIdstringrequired
guestUserIdstringrequired
No request payload

Responses

OK

Body
createdDateinteger(int64)read-only

Timestamp when the guest user was created.

deliveryMethodsArray of stringsuniquerequired

At least one delivery method.

Items Enum"MAIL""SMS""WHATSAPP""STUB""PRINT"
disabledboolean

If true, this guest user will not be permitted to join the guest network.

Example: false
emailstring(email)

Email address of the guest user.

expirationobject(GuestUserExpiration)required

Expiration configuration for the guest user account.

expiration.​activationTypestringrequired

When activation type is set to creation, the guest pass is valid when it's created until the specified expiration duration, even if it's not being used; when set to login, the guest pass is valid starting from when the user first logs on until the specified expiration duration.

Enum"Creation""Login"
expiration.​durationinteger(int32)

Duration value for the expiration period.

expiration.​unitstring

Time unit for the expiration duration.

Enum"Minute""Hour""Day""Week""Month""Year""Never"
expirationDateinteger(int64)read-only

Expiration date is calculated per the expiration configuration.

guestUserTypestringread-only

This field is not editable after creation.

Value"GuestPass,SelfSign,HostGuest"
Example: "GuestPass"
lastModifiedinteger(int64)read-only

Timestamp when the guest user was last modified.

macAddressesArray of stringsuniqueread-only

MAC addresses of the guest user's connected devices.

maxDevicesinteger(int32)required

Maximum number of devices the guest user can simultaneously connect to the guest network. If set to minus one, no limit is enforced.

Example: 3
mobilePhoneNumberstringrequired

The mobile phone number associated to the guest user.

namestringrequired

The name assigned to the guest user.

notesstring[ 0 .. 180 ] characters

Additional notes or comments about the guest user.

passwordstringread-only

The password is generated automatically by the system.

ssidstringread-only

SSID of the network to which the guest connected.

Response
{
  "createdDate": 0,
  "deliveryMethods": [
    "MAIL"
  ],
  "disabled": false,
  "email": "user@example.com",
  "expiration": {
    "activationType": "Creation",
    "duration": 0,
    "unit": "Minute"
  },
  "expirationDate": 0,
  "guestUserType": "GuestPass",
  "lastModified": 0,
  "macAddresses": [
    "string"
  ],
  "maxDevices": 3,
  "mobilePhoneNumber": "string",
  "name": "string",
  "notes": "string",
  "password": "string",
  "ssid": "string"
}

Update Guest User

Request

Update guest user enable/disable status or create new password for the guest user.

Path
wifiNetworkIdstringrequired
guestUserIdstringrequired
Body
required

Parameter combination option:

Option1: Enable or disable user by "disabled: false" or "disabled: true".

Option2: Regenerate guest user credential by "action: regeneratePassword" + "deliveryMethods"

actionstring

Action for updating guest user.

Enum"regeneratePassword""passwordValidation"
Example: "regeneratePassword"
deliveryMethodsArray of stringsunique

At least one delivery method.

Items Enum"MAIL""SMS""WHATSAPP""STUB""PRINT"
Example: ["MAIL","PRINT"]
disabledboolean

If true, this guest user will not be permitted to join the guest network.

Example: false
passwordstring

Manual password. The password must contain at least 6 characters (up to 16). The following characters are permitted: lowercase and uppercase letters, 0-9, and other special characters !@#$%^&*()[]{}-_+=~`|:;"'<>,./?.

{
  "action": "regeneratePassword",
  "deliveryMethods": [
    "MAIL",
    "PRINT"
  ],
  "disabled": false,
  "password": "string"
}

Responses

OK

Body
requestIdstring

Unique identifier that can be used to trace the request status in the activity service.

responseobject(GuestUserWithoutIdV1)

The response payload from the operation.

Response
{
  "requestId": "string",
  "response": {
    "createdDate": 0,
    "deliveryMethods": [ … ],
    "disabled": false,
    "email": "user@example.com",
    "expiration": { … },
    "expirationDate": 0,
    "guestUserType": "GuestPass",
    "lastModified": 0,
    "macAddresses": [ … ],
    "maxDevices": 3,
    "mobilePhoneNumber": "string",
    "name": "string",
    "notes": "string",
    "password": "string",
    "ssid": "string"
  }
}

Portal Service Profile

Manage portal service profile.

Operations

Portal Service Template

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

Operations