HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Modify settings at Configuration -> Guest Manager

Modify settings at Configuration -> Guest Manager

Body Params
string
enum
required

The method used to generate random account usernames

Allowed:
string

Identifier string to prepend to usernames.
Dynamic entries based on a user attribute can be entered as '_' + attribute. For example '_role_name'.
The username length will determine the length of the numeric sequence only. Recommend 4

string

Format picture (see below) describing the usernames that will be created for visitors.

• Alphanumeric characters are passed through without modification.
• ‘#’ is replaced with a random digit [0-9].
• ‘$’ or ‘?’ is replaced with a random letter [A-Za-z]
• ‘_’ is replaced with a random lowercase letter [a-z]
• ‘^’ is replaced with a random uppercase letter [A-Z]
• ‘’ is replaced with a random letter or digit [A-Za-z0-9].
• ‘!’ is replaced with a random punctuation symbol [excluding apostrophe, quotes]
• ‘&’ is replaced with a random character (union of sets ! and
)
• ‘@’ is replaced with a random letter or digit, excluding vowels
• '%' is replaced with a random letter or digit, excluding vowels and anything that looks like another (il1, B8, O0, Z2)

int64
required

The length, in characters, of generated account usernames

guest_initial_sequence_options
object

Create multi next available sequence number. These values will be used when multi_initial_sequence is set to -1

string
enum
required

The method used to generate a random account password

string

Format picture (see below) describing the passwords that will be created for visitors.

• Alphanumeric characters are passed through without modification.
• ‘#’ is replaced with a random digit [0-9].
• ‘$’ or ‘?’ is replaced with a random letter [A-Za-z]
• ‘_’ is replaced with a random lowercase letter [a-z]
• ‘^’ is replaced with a random uppercase letter [A-Z]
• ‘’ is replaced with a random letter or digit [A-Za-z0-9].
• ‘!’ is replaced with a random punctuation symbol [excluding apostrophe, quotes]
• ‘&’ is replaced with a random character (union of sets ! and
)
• ‘@’ is replaced with a random letter or digit, excluding vowels
• '%' is replaced with a random letter or digit, excluding vowels and anything that looks like another (il1, B8, O0, Z2)

int64
required

Number of characters to include in randomly-generated account passwords

string
enum
required

Password complexity to enforce for manually-entered guest passwords.
Requires the random password type ‘A password matching the password complexity requirements’
and the field validator ‘NwaIsValidPasswordComplexity’ for manual password entry

Allowed:
int64
required

The minimum number of characters that a guest password must contain

string

Characters which cannot appear in a user-generated password

string

Comma separated list of words disallowed in the random words password generator

boolean

If selected, guest and device Wi-Fi passwords may be displayed to an operator.
This is only possible if operators have the View Passwords privilege as well

integer
enum
required

Default action to take when the expire_time is reached.
Note that a logout can only occur if the NAS is RFC-3576 compliant

Allowed:
guest_account_expiry_options
object
required

The available options to select from when choosing the expiration time of a guest account (expire_after).
Expiration times are specified in hours

guest_modify_expire_time_options
object
required

The available options to select from when modifying an account's expiration (modify_expire_time).
Note some items may be dynamically removed based on the state of the account

guest_lifetime_options
object
required

The available options to select from when choosing the lifetime of a guest account (expire_postlogin).
Lifetime values are specified in minutes

boolean

If checked, users will receive an email notification when their device’s network credentials are due to expire.
Accounts must contain the ’expired_notify_status’ field with a value of ’1’. Once a notification is sent, this field will show as ’0’

int64

Account expiration emails are sent this many days before the account expires.
Enter a value between 1 and 30

string
enum

Specify where to send emails if the user’s account doesn’t have an email address recorded

Allowed:
string

Address used when no email address is known for a user

string

Domain to append to the username to form an email address

string

Enter a subject for the notification email

integer
enum

The plain text or HTML print template to use when generating an email message

string
enum

The format in which to send email receipts

string
enum

Specify when to send to the recipients in the Copies To list

Allowed:
string

An optional list of email addresses to which copies of expiry notifications will be sent

string
enum

Specify where to send emails if the user’s account doesn’t have an email or sponsor_email address recorded

Allowed:
string

Address used when no email address is known for a device

string

Enter a subject for the notification email

integer
enum

The plain text or HTML print template to use when generating an email message

string
enum

The format in which to send email receipts

string
enum

Specify when to send to the recipients in the Copies To list

Allowed:
string

An optional list of email addresses to which copies of expiry notifications will be sent

string

The SSID of the wireless LAN, if applicable. This will appear on guest account print receipts

string

The WPA key for the wireless LAN, if applicable. This will appear on guest account print receipts

boolean

Guest receipts can print simply by selecting the template in the dropdown, or by clicking a link

string

The URL of a terms and conditions page. The URL will appear in any terms checkbox with:
{nwa_global name=guest_account_terms_of_use_url}
It is recommended to upload your terms in Content Manager, where the files will be referenced with the "public/" prefix.
Alternatively, you can edit Terms and Conditions under Configuration > Pages > Web Pages.
If your site is hosted externally, be sure the proper access control lists (ACLs) are in place.
If terms are not required, it is recommended to edit the terms field on your forms to a UI type "hidden" and an Initial Value of 1

int64

Enable limiting the number of active sessions a guest account may have.
Enter 0 to allow an unlimited number of sessions

string

Template code to display on the Guest Manager start page, under the
“About Guest Network Access” heading. Leave blank to use the default text,
or enter a hyphen (“-”) to remove the default text and the heading

Responses

Language
Response
Choose an example:
application/json