Table of Contents

Managing Users

Jake Peters Updated by Jake Peters

Different people on your team build and market different parts of your product so it makes sense to collaborate on your docs and let experts write everything they know about each feature.

Understanding Roles

You can assign roles to team members you invite to HelpDocs depending on the actions they'll take inside the product. Here's a breakdown:

Role

Permissions

Owner

The Owner role is automatically assigned to the creator of the account. This role can do everything, including manage billing. Owners can't be deleted, but they can transfer ownership.

Administrator

Users with an Administrator role can do everything too. They can manage HelpDocs settings, billing, branding, and add/remove users and API keys. They can also edit all articles and content.

Editor

An Editor can see stats and manage content, but can't edit any settings or branding.

Read Only

Users with this role can only view content. This is usually paired with the Restrict to Logged In Users auth option.

Inviting a User

  1. Head to Settings > Users
  2. Switch to the Invitations tab
  3. Click Invite New User(s) at the bottom of the invitation table
  4. Fill out their email address, their role, and whether to send them an email invite or not
    If you don't send over an email invite they'll need to head to yourdomain.helpdocs.io/signup and enter their email address there
  5. Click Send Invite
Invite multiple users by separating email addresses with a comma, like so:

chromegoose@helpdocs.io, lindatherabbit@helpdocs.io, liveythepelican@helpdocs.io

Changing the Default User Role

When you invite a new team member in SettingsUsers they'll automatically be assigned a specific user role. You can change the role they'll be assigned.

  1. Head to Settings > Users and scroll down to the Settings section
  2. From the Default Role dropdown menu select the role you'd like to be assigned
  3. Click Save Changes

Changing Roles

  1. In your HelpDocs dashboard, head to Settings > Users
  2. Click the checkbox next to the team members you'd like to edit and click Edit User
  3. Choose a new role from the Role dropdown
  4. Click Save Changes

Transferring Ownership

If you're the owner of your account you can transfer ownership to any other user.

  1. Head over to Settings > Users
  2. Select the user you wish to transfer ownership to
  3. Click Edit User
  4. In the dropdown menu select Owner
  5. Hit Save Changes
Once you transfer your account to a new owner you'll become an Administrator instead. There's no way to reassign ownership to yourself later on. If you transfer ownership by mistake, contact support in-app as soon as possible.

Viewing Last Active Time

In the corner of each user's profile image in the users table you'll see a little dot indicating their status. If the user is currently online that dot will be green. If they're offline the dot will be grey.

You can hover over an offline user's profile image to see when they were last active.

Filtering Users

Looking to prune your users list? You can filter by users' activity, role, and user groups to find the subset of users you're interested in.

  1. Head to Settings > Users
  2. On the User tab click Filters to expand the filtering options
  3. Add your filters. You can filter by:
  • Name
  • Email
  • Inactive for x amount of time
  • Active in the last x amount of time
  • User group
  • Role
  1. Click Apply Filters

Deleting Users

If you're an Administrator or Owner you can delete users from your account

  1. Head to Settings > Users
  2. Select which users you'd like to delete using the checkboxes
  3. Click Edit x Users
  4. Click the trash icon in the top right of the popup

What did you think of this doc?

Logging In To Your HelpDocs

Get in touch