ShipStream Knowledge Base
System Administration

User Roles

User Roles define a set of "resources" or permissions which assigned users will be granted access to. Granting only the permissions necessary for a user's legitimate needs and purpose is good practice because it:

  • reduces risk should a user's account become compromised
  • helps protect the privacy of your customer's data
  • simplifies the user interface by removing functions that are not needed

Create a User Role

Navigate to System > Users, then click User Roles to access the User Roles grid.

Managing roles for Client Users is virtually the same except you would navigate to System > Users and click Client Users then Client User Roles.
  1. Navigate to the appropriate User Roles or Client User Roles grid and then click Add New Role.
  2. Choose a Role Name that describes what level of access users assigned to this Role with need or their job description (e.g. Accounting, Shipping, Customer Support, etc.).
  3. Optionally enter Notes to describe the Role or explain when to assign it. Notes are available on both Organization and Client User Roles. Notes on unrestricted Client User Roles appear in the client portal's User Roles tab, so do not enter sensitive information there.
  4. For Client User Roles, choose Restrict Client Assignment (default No). The field's note reads: "Client users cannot see or modify assignments to restricted roles." Set it to Yes to hide the Role from Client Users and prevent them from assigning or removing it. Existing assignments and the permissions they grant remain in effect. Only Organization Users with the appropriate Users or User Roles permission can manage these assignments. This option and Notes can also be edited on the built-in Administrators Client User Role; its name and permissions remain locked.
  5. For Organization User Roles select whether or not the role should be designated as Primary. This field does not appear or apply to Client Users.

    It is strongly recommended notto designate any role providing System > Permissions > User Groups or System > Permissions >User Roles as Primary to prevent secondary users from "breaking out" of their limited access. See User Groups for more information.
  6. If this role is used on a shared device with Microsoft Social Login, set End Social Login Session on Sign Out to Yes so signing out of ShipStream also ends the Microsoft session in that browser, and later Microsoft sign-ins on that browser ask for credentials instead of listing remembered accounts. This applies when any role assigned to the user has this set, so leave it No on every role of users who sign in from a personal computer. It does not apply to Google sign-in. This field does not appear on Client User Roles.
  7. Click the Role Resources tab in the left sidebar. Here you can determine which permissions the users assigned to this User Role (or Client User Role) will have.
  8. Choose Custom as the Resource Access type and check the boxes for the permissions you would like to grant to this role.
  9. Click Save Role.

The User Roles and Client User Roles grids include a Notes column. The Client User Roles grid also includes Restrict Client Assignment to help Organization Users identify restricted Roles.