Schedule a guest user.
Since Product Version: 3.7
-
Jump To
- AAA/TACACS+ Servers Operations Service (4)
- AP Onboarding Profile Management Service (4)
- API Health Service (6)
- Access Point Operations (5)
- Alarms Management Service (5)
- Application Visibility and Control Service (1)
- CLI Template Configuration (12)
- Clients (7)
- Compliance Service (5)
- Configuration Archive Service (7)
- Credential Profile Management Service (5)
- Credentials Service (1)
- Device Details (9)
- Device Operations (9)
- Group Management Service (8)
- Group Summary Service (8)
- Guest User Management Service (8)
- Job Operations (6)
- MAC Filters Management Service (5)
- Manage and Monitor Info Service (5)
- Managed Servers Operations (6)
- Plug and Play (11)
- Rate Limits Management Service (2)
- Report Service (4)
- Site Map Service (3)
- Software Updates (2)
- Statistics (91)
- System Settings (26)
- Trap Receivers (4)
- User Defined Field Management (3)
- User Management Service (5)
- VNF Provisioning (16)
- Virtual Domains Management Service (10)
- Virtual Image Repository (8)
- WLAN Provisioning (16)
- Wireless Device Details (22)
- v1
- v2
- v3
- v4
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
This resource was introduced in API version 4.
This resource was introduced in API version 4.
This resource was introduced in API version 4.
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
POST |
Resource URL
/webacs/api/v4/op/guestUser/scheduleRequest Payload Parameters
Attribute | Description |
---|---|
applyGuestUserTo ApplyGuestUserTo |
Required Approach to choose a set of controllers for applying the guest user account.
|
configGroup String |
Name of a config group for which the guest user is configured. This field using only if applyGuestUserTo equals CONFIG_GROUP. |
controllerId Long[] |
The list of controller IDs for applying the guest account. This field using only if applyGuestUserTo equals CONTROLLER_LIST. |
description String |
Description of the guest user. |
disclaimer String |
Text with a disclaimer for a guest. |
email String |
Required Email address of the guest user. Credentials of the scheduled guest user will be sent to this email address. |
endTime Date |
An expiry time for the limited guest user. If time is not specified the user is not limited. |
locationGroupId Long |
ID of the location group. This field using only if applyGuestUserTo equals INDOOR_AREA or OUTDOOR_AREA. |
newPasswordOnEverySchedule Boolean |
Generate new password on every schedule. Optional, false if not specified. |
profile String |
Required Name of a WLAN profile. The guest account will apply only to controllers with an appropriate WLAN profile. If the profile has a value "ANY PROFILE" the guest account will apply to all controllers. You can use the WlanProfiles API for getting a list of profiles. |
startTime Date |
Required Start time of guest user scheduling. Start time should be at least five minutes ahead of the current time. |
userRole String |
Required Name of a local net user role. The guest account will apply only on controllers with an appropriate user role. If the user role has a value "default" the guest account will apply to all controllers. You can use API WlanControllerDetails for getting a list of user roles appropriate for a controller. |
username String |
Required Name of the guest user. |
weekdays WeekdayEnum[] |
Days of the week when the guest user is scheduled. Optional, user will not be restricted by week days if not specified.
|
Response Parameters
Attribute | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
operationType GuestUserOperationType |
The operation type.
|
|||||||||||
The result of the operation on a certain WLAN controller. |
||||||||||||
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Request Payload
https://localhost/webacs/api/v4/op/guestUser/schedule
<?xml version="1.0" ?>
<scheduleGuestUsersDTO>
<applyGuestUserTo>CONTROLLER_LIST</applyGuestUserTo>
<configGroup>String value</configGroup>
<controllerIds>
<controllerId>15</controllerId>
<controllerId>25</controllerId>
</controllerIds>
<description>String value</description>
<disclaimer>String value</disclaimer>
<endTime>1986-07-24T00:00:00Z</endTime>
<locationGroupId>15</locationGroupId>
<profile>String value</profile>
<userRole>String value</userRole>
<username>String value</username>
<email>String value</email>
<newPasswordOnEverySchedule>true</newPasswordOnEverySchedule>
<startTime>1986-07-24T00:00:00Z</startTime>
<weekdays>
<weekdays>SUNDAY</weekdays>
<weekdays>MONDAY</weekdays>
</weekdays>
</scheduleGuestUsersDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v4/op/guestUser/schedule.json
{
"scheduleGuestUsersDTO" : {
"applyGuestUserTo" : "CONTROLLER_LIST",
"configGroup" : "String value",
"controllerIds" : {
"controllerId" : [ 15, 25 ]
},
"description" : "String value",
"disclaimer" : "String value",
"email" : "String value",
"endTime" : "1986-07-24T00:00:00.000Z",
"locationGroupId" : 15,
"newPasswordOnEverySchedule" : true,
"profile" : "String value",
"startTime" : "1986-07-24T00:00:00.000Z",
"userRole" : "String value",
"username" : "String value",
"weekdays" : {
"weekdays" : [ "SUNDAY", "MONDAY" ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v4/op/guestUser/schedule
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/guestUser/schedule" rootUrl="https://localhost/webacs/api/v4/op">
<guestUserOperationResultsDTO>
<operationType>CREATE</operationType>
<operationResults>
<operationResult>
<controllerName>String value</controllerName>
<ipAddress>
<address>192.168.115.243</address>
</ipAddress>
<operationStatus>NOT_ATTEMPTED</operationStatus>
<reason>String value</reason>
</operationResult>
<operationResult>
<controllerName>Another string value</controllerName>
<ipAddress>
<address>192.168.115.244</address>
</ipAddress>
<operationStatus>REJECTED</operationStatus>
<reason>Another string value</reason>
</operationResult>
</operationResults>
</guestUserOperationResultsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/guestUser/schedule.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/guestUser/schedule",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"guestUserOperationResultsDTO" : [ {
"operationResults" : {
"operationResult" : [ {
"controllerName" : "String value",
"ipAddress" : {
"address" : "192.168.115.243"
},
"operationStatus" : "NOT_ATTEMPTED",
"reason" : "String value"
}, {
"controllerName" : "Another string value",
"ipAddress" : {
"address" : "192.168.115.244"
},
"operationStatus" : "REJECTED",
"reason" : "Another string value"
} ]
},
"operationType" : "CREATE"
} ]
}
}