This field must be set to 1, indicating the creator has accepted the terms of use for creating the account. If the field is not present or is not set to 1, the guest account is not created.

If this field is specified, its value must be equal to the “password” field, or else the guest account is not created.

This field is the name for the guest account and may be provided directly. If this field is not specified, then use the email address from the email field, and if that is also not specified, then randomly generate a username (according to the value of the random_username_method and random_username_length fields).

This field controls password modification for the guest account. It may be set to one of these values:

“reset” to randomly generate a new password according to the values of the random_password_method and random_password_length fields

“password” to use the password specified in the password field

“random_password” to use the password specified in the random_password field

If blank or unset, the default password behavior is used, which is to use any available value from the random_password field and the password field, or assume that “reset” was specified otherwise.

This field is the password for the guest account and may be provided directly. If this field is not specified, then randomly generate a password (according to the values of the random_password_method and random_password_length fields).

This field is the role Type of access being granted. ClearPass lets you define multiple roles. Such roles could include employee, guest, team member, or press. Roles are used for both guest access (user role) and operator access to ClearPass. to assign to the guest account and may be specified directly. If this field is not specified, then determine the role ID from the role_name field. If no valid role ID is able to be determined, the guest account is not created.

This field determines the maximum number of concurrent sessions allowed for the guest account. If this field is not specified, the default value from the GuestManager configuration is used.

The method used to generate a random account username. If not specified, the default value from the GuestManager configuration is used.

The length in characters of random account usernames. If not specified, the default value from the GuestManager configuration is used.

The method used to generate a random account password. If not specified, the default value from the GuestManager configuration is used.

This field determines whether the account is enabled or disabled; if not specified, the default is 1 (account is enabled).

These fields are used to determine the time at which the guest account will be activated.

If modify_schedule_time is “none”, then the account is disabled and has no activation time set.

If modify_schedule_time is “now”, then the account is enabled and has no activation time set.

If modify_schedule_time is a value that specifies a relative time change, for example “+1h”, then the guest account’s activation time is modified accordingly.

If modify_schedule_time is a value that specifies an absolute time, for example “2010-12-31 17:00”, then the guest account’s activation time is set to that value.

If modify_schedule_time is “schedule_after” or “schedule_time”, then the activation time is determined according to the schedule_after or schedule_time fields as explained below.

If schedule_after is set and not zero, then add that time in hours to the current time and use it as the activation time (setting do_schedule to 1); enabled will be set to zero.

Otherwise, if schedule_after is zero, negative or unset, and schedule_time has been specified, use that activation time (set do_schedule to 1 and enabled to 0). If the schedule_time specified is in the past, set do_schedule to 0 and enabled to 1.

Otherwise, if schedule_time if not specified, then the guest account has no activation time and do_schedule will default to zero.

These fields are used to determine the time at which the guest account will expire.

If modify_expire_time is “none”, then the account has no expiration time set.

If modify_expire_time is “now”, then the account is disabled and has no expiration time set.

If modify_expire_time is a value that specifies a relative time change, for example “+1h”, then the guest account’s expiration time is modified accordingly.

If modify_expire_time is a value that specifies an absolute time, for example “2010-12-31 17:00”, then the guest account’s expiration time is set to that value.

If modify_expire_time is “expire_after” or “expire_time”, then the expiration time is determined according to the expire_after or expire_time fields as explained below.

If expire_after is set and not zero and the account will be activated immediately, then add the value in hours to the current time to determine the expiration time.

If expire_after is set and not zero and account activation is set for a future time (schedule_time) instead of the current time, then the expiration time is calculated relative to the activation time instead of the current time.

Otherwise, if expire_after is zero, negative or unset, and expire_time has been specified, use that expiration time. If the expire_time specified is in the past, set do_expire to 0 and ignore the specified expiration time.

If the expire_timezone field is used in conjunction with expire_time and a time zone and date are selected, the date calculation is adjusted relative to the time zone.

Otherwise, if expire_time is not specified, then the expire_time is not set and do_expire will always be set to zero.

If the do_expire field is not included in the form Interactive page in the application where users can provide or modify data., the default expiration action is 4, Logout and Delete. This can be configured on the Customize Guest Manager page.

This field determines the amount of time after the initial login for which the guest account will remain valid. If this field is not specified, the default value is 0 (account lifetime not set).