Users and roles
The Admin page sets who can sign in to the Console, and what each person can change. It also shows what people did.
Only administrators can see the Admin page. It is under ADMIN in the menu on the left. The page has 3 tabs: Users, Activity and Settings.
The Users tab
The Users tab lists every account that can sign in. Each row shows:
- the account's name, its user name and what kind of account it is.
- Off if the account is turned off, and Locked if it is locked.
- 2FA on or 2FA off, for two-step sign in. For an AD group, it shows how many of the people who signed in through the group have two-step sign in.
- the account's role, and when it last signed in.
Select a row to see and change the account on the right. Select Close (the cross) to close it.
Note
There must always be at least 1 local administrator that is turned on. You cannot remove the last one, turn it off or give it another role.
Add a user
- Select Add New User.
- Pick the kind of account from the table below.
- Fill in the boxes, pick a role, and set what the account can change.
- Select Save.
| Kind | Who it is for |
|---|---|
| Local user | Someone who signs in with a user name and password kept on the SharpDay Deploy server. |
| AD user | 1 person in Active Directory. They sign in with their Active Directory user name and password. |
| AD group | Everyone in an Active Directory group. Each person signs in with their own Active Directory user name and password. |
| Microsoft account | Someone who signs in with Microsoft (Entra ID). |
| Google account | Someone who signs in with their Google account. |
You can only pick AD user and AD group once Active Directory is turned on, on the Settings tab. In the same way, Microsoft account and Google account need Microsoft or Google turned on there.
The boxes
Not every box shows for every kind of account.
| Box | Shown for | What to put |
|---|---|---|
| Find in Active Directory | AD user, AD group | Type a name or part of it, select Search, then pick the account from the list. Directory account then shows the account you picked. |
| User name | Local user | The name they sign in with. It can be up to 64 characters, with no \, / or @. No 2 local users can have the same name. |
| Email address | Microsoft account, Google account | The email address they sign in with. |
| Display name | All | The name the Console shows for them. For an AD account, it is filled in from Active Directory. |
| Password and Password again | Local user | Their password, typed twice. It must be at least as long as Shortest password on the Settings tab. |
| Enabled | All | Turn this off to stop the account signing in. |
| Role | All | Administrator, Technician or Read only. A new account starts as Technician. |
| Access | All | What a technician can change. See What a technician can change below. |
A Microsoft or Google account is linked to the person the first time they sign in. Until then, the account shows "Not signed in yet". After that, it shows "Linked".
Roles
| Role | What it can do |
|---|---|
| Administrator | Everything. Administrators have complete access to all areas, including the Admin page. |
| Technician | See everything, and change the parts that are turned on under Access. A technician cannot add or change users. |
| Read only | See everything and change nothing. |
These things are for administrators only:
- the Admin page
- About > Export & Import. See Move, back up and restore.
- finishing First time setup
A change to an account takes effect straight away, even in a Console that is already signed in. If a change takes away all of someone's access, every Console they have open is signed out.
People with more than 1 entry
A person in Active Directory can get access from more than 1 entry. For example, they may have their own AD user entry and be in 2 AD group entries. They then get the highest role of those entries, and can change anything that any of the entries allows.
If you turn off a person's own AD user entry, they cannot sign in, whatever groups they are in.
If you turn off Active Directory, Microsoft or Google on the Settings tab, nobody can sign in with that kind of account.
What a technician can change
Under Access, each part of the Console has a switch:
- On: the technician can change it. The Console shows "Read and write".
- Off: the technician can only look at it. The Console shows "Read only".
The switches only work for the Technician role. An administrator can change everything, and a read only account can change nothing.
| Access | What it covers |
|---|---|
| Boot Files | Boot folders, WIM builds, iPXE and answer files |
| Services | Pause and resume the network services and shares |
| Operating Systems | WIM images, ISO files and Linux images |
| Drivers | Driver catalogs and driver packs |
| Automations | Edit and run automations. These run on the server as SYSTEM. |
| SDDN Servers | Deployment nodes |
| Credentials | Saved user names and passwords |
| The addresses the server sends from | |
| Autopilot | Autopilot settings |
| Alerts | Email alerts |
| Reroute | Routing rules and groups |
| Known Clients | Known clients, AD sync, and approving held machines |
| Clients | Sign in at a PE client to start deployments, and pause, resume or cancel them |
| Client themes | How the deployment client looks |
| Live Logging | The server log |
| Updates | Install updates and repair client files |
| Licence | Upload a licence |
Warning
Workflow steps that run on the server run as SYSTEM, the strongest account in Windows. Only give change access to Automations to people you trust with the server itself. See Workflows.
Tip
If people must sign in at the PE client before a deployment, their account needs change access to Clients. You set this sign in on Settings > PE Client.
Change a password
You can only change passwords for a Local user. SharpDay Deploy does not keep passwords for Active Directory, Microsoft or Google accounts. Change those in Active Directory, Microsoft or Google.
- Select the user.
- Type the new password in New password (leave blank to keep), then again in Password again.
- Select Save.
The user is signed out of every other Console where they are signed in. A new password also unlocks the account.
Local users can also change their own password. They open Your account at the top of the Console, then select Change password.
Unlock an account
A local account locks after too many wrong passwords in a row. It shows Locked. You set how many tries, and how long it stays locked, on Settings > Passwords and lockout.
There is no unlock button. The account unlocks when one of these happens:
- The time in Minutes it stays locked passes.
- You give it a new password and select Save.
- You select Reset two-step. This also removes the user's two-step sign in, so only use it when they need that too.
Two-step sign in
Two-step sign in asks for a code from an authenticator app after the password.
Each person turns it on for themselves. They open Your account at the top of the Console, then select Turn on two-step sign in. To make two-step sign in a must, turn on Force require 2FA for local users on Settings > Two-step sign in.
When someone turns it on, they get recovery codes. Each code works once, for when they lose their phone. If they cannot sign in at all, an administrator can reset their two-step sign in:
- Select the user.
- Select Reset two-step.
Their two-step sign in is removed, and they can set it up again.
For an AD group, each person who has signed in through the group is listed under People who have signed in. To reset one person, select Reset two-step next to their name.
Sign out everywhere
Select Sign out everywhere to sign the account out of every Console where it is signed in. The person sees "An administrator signed you out." They can sign in again.
To see what an account has done, select Activity. The Activity tab opens with only that account's entries.
Turn off or remove an account
- To stop someone signing in for now, turn off Enabled, then select Save. Every Console they have open is signed out, and the row shows Off. Turn Enabled back on to let them in again.
- To remove an account, select Remove. When the Console asks "Remove this account?", select Remove again. Every Console they have open is signed out.
There are some limits, so nobody is locked out of the server:
- You cannot turn off or remove your own account, or take away your own administrator role.
- You cannot make any change that takes away your own administrator access, for example by changing an AD group you are in. Ask another administrator to make the change.
- You cannot remove, turn off or change the role of the last local administrator that is turned on.
The Activity tab
The Activity tab is the audit log. It is a record of who did what, and when.
To find entries:
- Type in Search, pick a person (or Everyone), and pick a type of event (or All events).
- If you need to, set the From and To dates.
- Select Search.
To show all entries again, select Clear.
The types of event are Sign-ins, Failed and refused, Changes, Users and settings, Deployments and builds, Files and exports and Updates and licence.
Each entry shows When, Who, From, Event, What and Result. Select Load more to see older entries.
- Export saves the audit log as a
.csvfile. - Check log checks that no entry has been changed or removed.
You choose what gets recorded on Settings > Audit log.
The Settings tab
The Settings tab has 8 cards. Select Save sign in settings to save the first 7. The Audit log card has its own button, Save audit settings.
| Card | What it sets |
|---|---|
| Sessions | How many idle minutes pass before a Console is signed out. Offer "Stay signed in" lets people stay signed in, idle or not, for the number of days you set. |
| Passwords and lockout | The shortest password for local users, how many wrong passwords lock an account, and how many minutes it stays locked. |
| Active Directory | Turns on sign in for Active Directory users and groups. Set the domain, a domain controller if you want a fixed one, the account used to find users and groups, and if LDAPS (port 636) is used. |
| Two-step sign in | Force require 2FA for local users makes two-step sign in a must. People who do not have it must set it up at their next sign in. |
| PE Client | If someone must sign in at the PE client before a deployment (Never, Only for unknown machines or Always). Also, if PCs with no Known Clients record deploy as normal or wait for approval. |
| Microsoft | Turns on sign in with Microsoft. You need an app registered in Entra ID, with its tenant ID and client ID. The client secret is only needed if the app uses one. |
| Turns on sign in with Google. You need a Desktop app OAuth client from Google Cloud, with its client ID and client secret. You can also allow only 1 domain. | |
| Audit log | Which events, and changes to which parts of the Console, are recorded. Also how many days entries are kept, and if they are also written to the server log. |
For the Active Directory card, the account used to find users and groups is either This server's own account, or a saved account from Automations > Credentials.