Admin User Management

From Obsidian Scheduler
Jump to navigationJump to search

User management can be accessed by Admin users from the primary navigation sidebar. The current user may view their rights and/or change their password by using the user name drop-down in the top right corner of the screen.

All users may see their current rights. In addition, if native authentication is used, all users may change their password. Admin users may also view and manage users when native authentication is used.

Viewing Rights & Changing Your Password

Selecting My User from the user name dropdown in the top right of the screen will bring you to the page which lists your user rights. If native authentication is used, you may also change your password from this page.

UserChangePassword 4.0.png


UserChangePasswordFull 4.0.png

Listing Users

Admin users may view current users, add users, and update settings and passwords of existing users.

UserListing 4.0.png


Exporting Results

The current contents of the table can be exported to Excel, CSV or XML by clicking on export icon displayed at the far right of the table header. The download will automatically begin and will include all pages of the current table of results.


Changing or Adding Users

Clicking the (+) button in the table header will bring you to the New User screen. Clicking a user in the table will allow you to edit or view a user. For security reasons, you must always enter your current user password to make user changes.

Note: The question mark icon that appears next to the form title indicates inline help. Click on the icon to see help related to the current page.

AddUserSave 4.0.png


When saving changes, you may receive error notifications. In this case, no changes were saved and you may correct your user setup and resubmit.

Note: When editing existing users, you may change their password by entering the new password and confirmation. If you leave both blank, the password will remain unchanged.


AddUserEnterPassword 4.0.png

Deleting Users

You can also delete users from the edit page. For security reasons, you must always enter your current user password before deleting a user. You will be prompted to confirm the delete action.

Note: Deleting users can make tracking down who made changes more difficult. Consider making a user inactive instead.

DeleteUser 4.0.png

User Rights

Rights are broken out into these categories: Default (read), Write, Admin, API Access, Author and Operator. In addition, as starting with Obsidian 2.0, Default read access can be limited using the Limited Read Access setting.

  • Default rights allow you read access to most parts of the application, with the exception of user lists and the Scheduler Settings screen.
  • Write rights allow you perform most operations, with the exception of viewing and changing users, and the Scheduler Settings screen.
  • API Access grants the user the ability to use the full REST API. In addition, this role grants the Default read access to the admin application.
  • Limited Read Access prevents the user from seeing potentially sensitive job configuration parameters. If you wish to hide these values from a user, grant them this right, otherwise leave it unselected. Note that if a user has Write or API Access, this setting has no effect.
  • Author rights allow you to create and modify jobs, job chains and conflicts. As of Obsidian 5.0.0
  • Operator rights allow a user to resubmit failed jobs, submit ad-hoc jobs, interrupt running jobs and pause/resume scheduling hosts. As of Obsidian 5.0.0

Job Folder Rights

Understand the job folder feature.

As of Obsidian 5.0, more granular rights can be assigned to users that are based on the root job folder specified on a job. Any job that doesn't have a job folder specified will require the standard rights listed in User Rights above. For example, if a job has the folder Maintenance or Maintenance/BackOffice, a user with the role Maintenance-Author has the Author permissions as noted below.

For rights that allow creation/modification of jobs, the job folder can only be set/changed by the user if it continues to respect the user's job folder authoring permissions. This also implies the job folder cannot be cleared by this user. For example, if a user has the roles Maintenance-Write and DevOps-Write, they can create a job that has a root folder Maintenance or DevOps, optionally with any subpath. The user cannot create a job with no job folder, nor can they change a job's folder to something other than a root of Maintenance or DevOps.

The 3 permissions supported by folder convention roles are similar, but not identical to the broader roles listed in User Rights above.

  • Write access by root job folder allows a user to create/modify, submit for ad-hoc and resubmit failed jobs that have a matching root job folder.
  • Author access by root job folder allows a user to create and modify jobs that have a matching root job folder.
  • Operator access by root job folder allows a user to resubmit, interrupt and submit ad-hocs that have a matching root job folder.


Multi-Factor Authentication (MFA)

As of Obsidian 5.0

Note: MFA does not apply to the REST API, and any user with API privileges will be able to invoke endpoints without an MFA code.

Obsidian supports multi-factor authentication via Google Authenticator, which generates rotating one-time codes on your mobile device. Other MFA approaches such as email and SMS are not supported, as they have inherent security issues.

To enable MFA, simply configure the Scheduler Settings mfaSetupDays and mfaEnabled. Once MFA is enabled, the mfaSetupDays setting controls how long users have to log in and set up MFA for their account. If they do not log in and complete setup within this time, they will be locked out and an MFA Reset will have to be performed.


MFA scheduler settings.png

Completing MFA Setup

Once MFA is enabled, when you log in you will see the typical login screen. After entering your user name and password, you will be prompted to perform set up with Google Authenticator. Simply follow the on-screen instructions to scan the presented QR code. Once setup is complete, you will be logged in.


MFA setup prompt.png

Logging in After Setup

After initial setup is complete, when you log in you will still see the typical login screen. After entering your user name and password, you will be prompted to enter the appropriate code from Google Authenticator to complete login.

MFA Resets

If a user does not complete MFA setup within the allowed time, or a new user is added when not using Obsidian native authentication, you may need to perform an MFA reset so that they may complete MFA setup and log in. It can also be used to force a user to re-perform MFA setup and invalidate any existing Google Authenticator entries for the account.

When MFA is enabled, the typical user listing table will include a button to perform MFA Resets.


MFA user listing reset button.png

The screen presented after clicking this button will allow you to reset one or more users' MFA state. Either select a known user from the list, or type a user name and click the plus button. Your current user password must also be entered for security reasons.


MFA reset page.png

When you are happy with your changes, click the Reset button.


MFA reset success.png

Users will then be allowed to perform MFA setup for the number of days configured via mfaSetupDays.