Skip to content

Guest API and Model Documentation (1.7.0)

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

Overview

Rate Limit

For the ApOps REST API the following will be true:

  • Limits are applied to each tenant.
  • A maximum of 200 calls can be made per second.
  • Each second 100 calls will be returned to be used.
Download OpenAPI description
Download PDF
Overview
License

RUCKUS Cloud Privacy Policy

Languages
Servers
Asian region

https://api.asia.ruckus.cloud/

European region

https://api.eu.ruckus.cloud/

North American region

https://api.ruckus.cloud/

Portal Service Profile

Manage Portal Service Profile.

Operations

Guest User

Manage guest users.

Operations

Add Guest User

Request

Create a new guest user.

Path
wifiNetworkIdstringrequired

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
filestring(binary)required
{
  "file": "string"
}

Responses

Created

Body
One of:
requestIdstring
responseArray of objects(GuestUserImportV2)
Response
{
  "requestId": "string",
  "response": [
    { … }
  ]
}

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: a-z, A-Z, 0-9, and other special characters !@#$%^&*()[]{}-_+=~`|:;"'<>,./?.

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

Responses

OK

Body
requestIdstring
Response
{
  "requestId": "string"
}

Get Guest User by ID

Request

Get a guest user.

Path
wifiNetworkIdstringrequired
guestUserIdstringrequired
No request payload

Responses

OK

Body
createdDateinteger(int64)read-only
lastModifiedinteger(int64)read-only
namestringrequired

The name assigned to the guest user.

disabledboolean

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

Example: false
notesstring[ 0 .. 180 ] characters
emailstring
mobilePhoneNumberstringrequired

The mobile phone number associated to the guest user.

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
macAddressesArray of stringsuniqueread-only

MAC addresses of the guest user's connected devices.

ssidstringread-only

SSID of the network to which the guest connected.

deliveryMethodsArray of stringsuniquerequired

At least one delivery method.

Items Enum"MAIL""SMS""WHATSAPP""STUB""PRINT"
guestUserTypestringread-only

This field is not editable after creation.

Enum"GuestPass""Anonymous""SelfSign""HostGuest""Directory""SAML""GuestPass,SelfSign,HostGuest"
Example: "GuestPass"
expirationobject(GuestUserExpiration)required
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)
expiration.​unitstring
Enum"Minute""Hour""Day""Week""Month""Year""Never"
passwordstringread-only

The password is auto-generated by the system.

expirationDateinteger(int64)read-only

Expiration date is calculated per the expiration configuration.

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

Delete Guest User by ID

Request

Delete a guest user.

Path
wifiNetworkIdstringrequired
guestUserIdstringrequired
No request payload

Responses

OK

Body
requestIdstring
Response
{
  "requestId": "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"

disabledboolean

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

Example: false
actionstring

Action for updating guest user.

Enum"regeneratePassword""passwordValidation"
Example: "regeneratePassword"
passwordstring

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

deliveryMethodsArray of stringsunique

At least one delivery method.

Items Enum"MAIL""SMS""WHATSAPP""STUB""PRINT"
Example: ["MAIL","PRINT"]
{
  "disabled": false,
  "action": "regeneratePassword",
  "password": "string",
  "deliveryMethods": [
    "MAIL",
    "PRINT"
  ]
}

Responses

OK

Body
requestIdstring
responseobject(GuestUserWithoutIdV1)
Response
{
  "requestId": "string",
  "response": {
    "createdDate": 0,
    "lastModified": 0,
    "name": "string",
    "disabled": false,
    "notes": "string",
    "email": "string",
    "mobilePhoneNumber": "string",
    "maxDevices": 3,
    "macAddresses": [ … ],
    "ssid": "string",
    "deliveryMethods": [ … ],
    "guestUserType": "GuestPass",
    "expiration": { … },
    "password": "string",
    "expirationDate": 0
  }
}