To connect to VirtServer from ReadyAPI Virtualization, you need to have at least one user registered on VirtServer.

We recommend adding a user for each person working with VirtServer.

There are three ways of creating users for VirtServer:

Regular way – the admin creates users on VirtServer manually. The way of creating and managing such users is described below.
LDAP – the admin sets up a connection to the LDAP service, and users connect to VirtServer using their LDAP credentials. This way is described in this topic.
OIDC (Okta) – the admin sets up a connection to the OIDC/Okta service, and users connect to VirtServer using their OIDC/Okta credentials. This is described in this topic.

Note:

User management is not possible from VirtServer once configured for OIDC. Users must be added and configured for access in Okta before they can log in to be added to the VirtServer instance.

User roles

VirtServer 3.1.0 and later has two user roles: regular users and administrators.

Regular users can work with virtual services: deploy, remove, start, and stop them and change their settings using the VirtServer panel in ReadyAPI Virtualization, the VirtServer web interface, or the command-line utility.
Administrators can add, edit, and remove users and change VirtServer settings in addition to all the tasks regular users can perform.

VirtServer prior to 3.1.0 does not have the concept of user roles. All the users are essentially administrators and can perform any actions with VirtServer.

User groups

To set up user permissions, you can configure user groups. A user will only be able to work with virtual services that are assigned to the group the user is part of or not assigned to any group. Administrators are able to work with any services regardless of their group status.

To learn more about it, see Manage Groups.

Create a user

VirtServer 3.1.0 and later checks if it has any users when it starts. If there are no users, VirtServer will create a default admin user with the defaultUser name and the svp4ever password. If you upgrade to 3.1.0 from an earlier version and the instance of VirtServer has existing users, they will all be converted into admin users.

Create the first user in VirtServer prior to 3.1

Using web interface

Go to the home page of VirtServer:

https://<virtserver-host>:<port>/virtserver#/

For example, if VirtServer is installed on your local machine and you run it on the default port, use the following link:

https://localhost:9090/virtserver#/
Go to Admin > Users and click the Add User button:

Click the image to enlarge it.

In the dialog that appears, input the user's information and click Add User:

Field	Description
First Name	Optional. The first name of the user.
Last Name	Optional. The last name of the user.
Username	Required. The username that the user will input to sign in to VirtServer.
Email Address	Optional. The email address of the user.
Password	Required. The password that the user will input to sign in to VirtServer.
Administrator	Check to give the new user administrator rights.

Using command-line

We do not recommend that you use virtserver.bat/.sh to add users. Use the VirtServer command line instead.

To add a user via the command line:

Launch VirtServer with the -a <user> command-line argument:

<VirtServer directory>\bin\virtserver.bat -a JohnSmith

On Linux and macOS, use the .sh file, rather than .bat.
VirtServer will ask you to enter the user's password.

You can add one user per command run. If VirtServer is already running, you will have to restart it so that new users can work with it.

In 3.1.0 and later, users created this way won't have administrator rights.

Get user list

We do not recommend that you use virtserver.bat/.sh to get user lists. Use the VirtServer command line instead.

To get a list of users registered on VirtServer using the command line:

Launch VirtServer with the -u command line argument:

<VirtServer directory>\bin\virtserver.bat -u
VirtServer will display a list of all existing users.

Tip:

You can also see the list of users in the VirtServer web interface.

Edit a user

Using web interface

Go to the home page of VirtServer:

https://<virtserver-host>:<port>/virtserver#/

For example, if VirtServer is installed on your local machine and you run it on the default port, use the following link:

https://localhost:9090/virtserver#/
Go to Admin > Users and click :

Click the image to enlarge it.

In the dialog that appears, change the user's information and click Save:

Field

Description

First Name

The first name of the user.

Last Name

The last name of the user.

Username

The username that the user will input to sign in to VirtServer.

This field cannot be edited.

Email Address

The email address of the user.

New Password

The password that the user will input to sign in to VirtServer.

Administrator

Check to give the user administrator rights. Uncheck to revoke administrator rights.

Note:

If the user is the only administrator on the server, you won't be able to revoke their administrator rights.

Tip:

Users can update their own information and passwords using the Profile menu.

Using command-line

We do not recommend that you use virtserver.bat/.sh to modify users. Use the VirtServer command line instead.

In the command line, you can only change the user's password. To do that:

Launch VirtServer with the -e <user> command-line argument:

<VirtServer directory>\bin\virtserver.bat -e JohnSmith
VirtServer will ask you to enter the user's password.

Tip: If passwordComplexityMode is enabled, the password must be at least 6 characters long and must contain at least one number and at least one capital letter.

Tip:

Users can update their own information and passwords using the Profile menu.

Delete a User

Using web interface

Go to the home page of VirtServer:

https://<virtserver-host>:<port>/virtserver#/

For example, if VirtServer is installed on your local machine and you run it on the default port, use the following link:

https://localhost:9090/virtserver#/
Go to Admin > Users and click :

Click the image to enlarge it.

Using command-line

We do not recommend that you use virtserver.bat/.sh to remove users. Use the VirtServer command line instead.

Launch VirtServer with the -d <user> command-line argument:

<VirtServer directory>\bin\virtserver.bat -d JohnSmith
VirtServer will ask you to enter the user's password.

Manage VirtServer Users

User roles

User groups

Create a user

Using web interface

Using command-line

Get user list

Edit a user

Using web interface

Using command-line

Delete a User

Using web interface

Using command-line

See Also