Update Guest User

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

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

Delete Guest UsersDeprecated

Request

Delete one or more guest users per their IDs as defined in the payload. This method will be removed no sooner than 08/31/2026.

Bodyapplication/jsonrequiredArray [

string

]

application/json

[
  "string"
]

Responses

Bodyapplication/json

requestIdstring

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

responseany

The response payload from the operation.

Response

application/json

{
  "requestId": "string",
  "response": null
}

Get Guest UsersDeprecated

Request

Get user details for the list of provisioned guest users. This method will be removed no sooner than 08/31/2026.

Query

pageinteger(int32)

Page index

Default 1

sizeinteger(int32)

The size of the page to be returned

Default 50

No request payload

Responses

Bodyapplication/json

contentArray of objects(GuestUser)

List of items in the current page.

totalElementsinteger(int64)

Total number of elements across all pages.

Response

application/json

{
  "content": [
    { … }
  ],
  "totalElements": 0
}

Add Guest UsersDeprecated

Request

Provision one or more guest users as defined in the payload. This method will be removed no sooner than 08/31/2026.

Bodyapplication/jsonrequiredArray [

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.

networkIdstringnon-emptyrequired

Network ID of the guest network.

notesstring[ 0 .. 180 ] characters

Additional notes or comments about the guest user.

]

application/json

[
  {
    "deliveryMethods": [ … ],
    "disabled": false,
    "email": "user@example.com",
    "expiration": { … },
    "maxDevices": 3,
    "mobilePhoneNumber": "string",
    "name": "string",
    "networkId": "string",
    "notes": "string"
  }
]

Responses

Created

Bodyapplication/json

requestIdstring

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

responseArray of objects(GuestUser)

The response payload from the operation.

Response

application/json

{
  "requestId": "string",
  "response": [
    { … }
  ]
}

Delete Guest User by IDDeprecated

Request

Delete a guest user. This method will be removed no sooner than 08/31/2026.

Path

guestUserIdstringrequired

No request payload

Responses

Bodyapplication/json

requestIdstring

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

responseany

The response payload from the operation.

Response

application/json

{
  "requestId": "string",
  "response": null
}

Get Guest User by IDDeprecated

Request

Get a guest user. This method will be removed no sooner than 08/31/2026.

Path

guestUserIdstringrequired

No request payload

Responses

Bodyapplication/json

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

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"

idstringread-only

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.

networkIdstringnon-emptyrequired

Network ID of the guest network.

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

application/json

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

Update Guest UserDeprecated

Request

Update guest user enable/disable status or create new password for the guest user. This method will be removed no sooner than 08/31/2026.

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"

actionstringnon-emptyrequired

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

Bodyapplication/json

requestIdstring

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

responseobject(GuestUser)

The response payload from the operation.

Response

application/json

{
  "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",
    "networkId": "string",
    "notes": "string",
    "password": "string",
    "ssid": "string"
  }
}

Import Guest UsersDeprecated

Request

Import one or more guest pass users from the payload's CSV file. This method will be removed no sooner than 08/31/2026.

Path

networkIdstringnon-emptyrequired

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

Query

expiration.activationTypestringrequired

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

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

responseobject(GuestUserImport)

The response payload from the operation.

Response

application/json

{
  "requestId": "string",
  "response": {
    "data": [ … ],
    "downloadUrl": "string"
  }
}

Portal Service Profile

Manage portal service profile.

Operations