Skip to content
/
Delete Guest Users

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

Import Guest Users by Network IDDeprecated

Request

Import one or more guest pass users from the payload's CSV file.

Path
networkIdstringrequired

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"
Bodymultipart/form-datarequired
filestring(binary)required
multipart/form-data
{
  "file": "string"
}

Responses

Created

Bodyapplication/json
requestIdstring
responseobject(GuestUserImport)
Response
application/json
{
  "requestId": "string",
  "response": {
    "downloadUrl": "string",
    "data": [ … ]
  }
}

Get Guest UsersDeprecated

Request

Get user details for the list of provisioned guest users.

Query
pageinteger(int32)

Page index

sizeinteger(int32)

The size of the page to be returned

No request payload

Responses

OK

Bodyapplication/json
contentArray of objects(GuestUser)
totalElementsinteger(int64)
Response
application/json
{
  "content": [
    { … }
  ],
  "totalElements": 0
}

Add Guest UsersDeprecated

Request

Provision one or more guest users as defined in the payload.

Bodyapplication/jsonrequiredArray [
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
networkIdstringrequired

Network ID of the guest network.

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
deliveryMethodsArray of stringsuniquerequired

At least one delivery method.

Items Enum"MAIL""SMS""WHATSAPP""STUB""PRINT"
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"
]
application/json
[
  {
    "name": "string",
    "disabled": false,
    "networkId": "string",
    "notes": "string",
    "email": "string",
    "mobilePhoneNumber": "string",
    "maxDevices": 3,
    "deliveryMethods": [ … ],
    "expiration": { … }
  }
]

Responses

Created

Bodyapplication/json
requestIdstring
responseArray of objects(GuestUser)
Response
application/json
{
  "requestId": "string",
  "response": [
    { … }
  ]
}

Delete Guest UsersDeprecated

Request

Delete one or more guest users per their IDs as defined in the payload.

Bodyapplication/jsonrequiredArray [
string
]
application/json
[
  "string"
]

Responses

OK

Bodyapplication/json
requestIdstring
responseobject
Response
application/json
{
  "requestId": "string",
  "response": {}
}

Get Guest User by IDDeprecated

Request

Get a guest user.

Path
guestUserIdstringrequired
No request payload

Responses

OK

Bodyapplication/json
idstringread-only
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
networkIdstringrequired

Network ID of the guest network.

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
application/json
{
  "id": "string",
  "createdDate": 0,
  "lastModified": 0,
  "name": "string",
  "disabled": false,
  "networkId": "string",
  "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 IDDeprecated

Request

Delete a guest user.

Path
guestUserIdstringrequired
No request payload

Responses

OK

Bodyapplication/json
requestIdstring
responseobject
Response
application/json
{
  "requestId": "string",
  "response": {}
}

Update Guest UserDeprecated

Request

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

Path
guestUserIdstringrequired
Bodyapplication/jsonrequired

Parameter combination option:

Option1: Enable or disable user by "action: enabled" or "action: disabled".

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

actionstringrequired

Action for updating guest user.

Example: "enabled"
deliveryMethodsArray of stringsunique

At least one delivery method.

Items Enum"MAIL""SMS""WHATSAPP""STUB""PRINT"
Example: "MAIL"
application/json
{
  "action": "enabled",
  "deliveryMethods": "MAIL"
}

Responses

OK

Bodyapplication/json
requestIdstring
responseobject(GuestUser)
Response
application/json
{
  "requestId": "string",
  "response": {
    "id": "string",
    "createdDate": 0,
    "lastModified": 0,
    "name": "string",
    "disabled": false,
    "networkId": "string",
    "notes": "string",
    "email": "string",
    "mobilePhoneNumber": "string",
    "maxDevices": 3,
    "macAddresses": [ … ],
    "ssid": "string",
    "deliveryMethods": [ … ],
    "guestUserType": "GuestPass",
    "expiration": { … },
    "password": "string",
    "expirationDate": 0
  }
}