Setting the Security Mode
  • 16 Jul 2023
  • 1 Minute to read
  • Dark
    Light

Setting the Security Mode

  • Dark
    Light

Article summary

General

DataWORQ Security has various modes outlined below. All modes share the concept of users. Users can either be an Admin (which gives them the ability to add and manage users among other settings) or a User (which gives basic application access). Admins and Users are both considered Interactive Users which means they can login and interact with the application via the user interface. There is also the concept of Api Users which are intended to interact exclusively with the DataWORQ api and do not have access to login to the user interface.

Admin Rights

Administrators have the following application rights:

  • Manage Interactive and Api Users
  • Manage Settings
    • Manage global application settings
    • Manage license settings
  • Manage automated tasks
    • Manage Job Scheduling
    • Manage File Watcher
    • Manage Cube Watcher

Setting the security mode after installation

  1. Open the dataworq.properties file located in your DataWORQ installation directory.

  2. Locate the security.auth-mode setting and set it to your desired security mode:
# Authentication modes include: 
#	BASIC - Basic username/password authentication
#	AD - Microsoft Active Directory
#	LDAP - Vendor-neutral directory service
#	OIDC - Open ID Connect
#	AZURE_OIDC - Open ID Connect via Azure AD  
#	SAML - SAML2.0-based authentication
security.auth-mode=BASIC

  1. Each security mode has its own dedicated set of sections included in the properties file (BASIC has no additional settings required).

  1. Uncomment and set the settings for your selected security mode (remove the # character before each line to uncomment it).

  1. For example if Active Directory was selected the uncommented settings would look like this:
######################################################################
#Active Directory#####################################################
######################################################################
ad.contextUrl=ldap://192.168.1.242:389
ad.domain=mydomain

NOTE: Setting up security modes other then BASIC will require configuration for the provider. If you need guidance or explanation of the available settings please reach out to support@quebit.com

Login after setup

Once you restart DataWORQ after updating the security mode it is time to login. Enter the credentials for the first administrator user. The first login attempt will add the user as an administrator and login you in.


Was this article helpful?

What's Next