V-Spark Online Help

Creating a User Account

V‑Spark user accounts can be created manually using the GUI, and manually or programmatically using the REST API's /config/users/ endpoint. For more information about using the API, see the API reference. Users may also request a new account if the installation has this feature enabled.

  1. Select the blue + sign at the far right of the User Accounts section of the Account Settings screen.

    The Create New User window appears:

    vspark-create-user-popup.png
  2. Use the Company drop-down menu to select the company that will be the account's home company.

  3. Enter the user's Full Name, Email address, and Username (the user's login name for V‑Spark). The username and email address for each user must be unique.

  4. Specify the source for the new user's password. You must choose one of the available options:

    1. Send user link to set password — sends the new user an email with a link that can be used to set an initial password.

      When the password has been successfully set, V‑Spark sends an additional email confirmation to the user.

    2. Set password for user — displays a Password field that can be used to set an initial password. Passwords must adhere to the installation's password requirements.

    3. Use external auth method — integrates the user's account with an external authentication method so that they do not need a V‑Spark-specific username and password.

      This option displays only if the installation has been configured to use external authentication, as in the following example:

      vspark-create-user-external-auth.png

      Selecting Use external auth method displays a drop-down list of the external authentication mechanisms with which your installation has been integrated. The only currently supported external authentication method is OpenID Connect (OIDC) using single sign-on (SSO). Refer to Using Single Sign-On (SSO) with V‑Spark for more information.

  5. Click Add user.