In Ghostwriter <= v3.x, the role-based access controls described on this page apply only to the GraphQL API. In those older versions, user privileges are equivalent to every account having the
manager
role.Introduction
User roles are the primary authorization mechanism. There are three user roles:- User
- Manager
- Admin
user
role by default.
If you look in the Hasura GraphQL console, you will also see a
public
role. Only Hasura uses this role. An unauthenticated request (i.e., any request that lacks a valid JWT in a request’s Authorization
header) is considered to have the public
role. Specific webhook endpoints (e.g., login
) are accessible to this role.User Role Privileges
Theuser
role can only access project and related client data if they:
- have been assigned to the project
- have been invited to access the client
- have been invited to access the project
user
role will only see project details if they can access the project or the related client.
Someone with the
manager
or admin
role can invite a user to access a client or project via the Invitations tabs on the client dashboard or the People tab on the project dashboard. If the user is invited to a project, they will automatically be granted access to the related client but not the client’s other projects.Augmenting User Permission
An admin can augment user permissions in the admin console. By default, theuser
role cannot edit, update, or delete entries in the Findings or Observation libraries.
Manager Role Privileges
Themanager
role can view all clients and projects. The role can also:
- invite others to access client data
- invite others to access project data
- assign others to a project
- edit report templates flagged as protected
manager
role.
Users with thr manager
role can invite users to have full access to a client or project from the client and project dashboards.
Admin Role Privileges
Theadmin
role is only used by the GraphQL API. This role has complete access to everything available via the API. This role can create and manage users and modify fields not exposed to other roles.
Use great care when assigning this role to an account. In general, a user should only ever be a
manager
or a user
.