Roles
This guide covers how to create, edit, and manage Zendesk user roles at GitLab. Administrators should review the Administrator tasks section.
Technical Details
- Deployment type:
Ad-hoc- Note: Roles are currently managed manually in Zendesk (no sync repo yet)
Understanding roles
What are Zendesk user roles
Zendesk uses Roles as a way to maintain permission sets for agents.
How we manage roles
We currently manage all roles within Zendesk itself.
Current roles in use
Note
This should be the single source of truth for the roles used. Never make changes outside of approved workflows.
Always be cautious of changes. Many of these can have significant downstream impacts.
For more information on what permissions the roles have, please see this doc (internal).
Zendesk Global
- Admin
- BPO
- Chat-only agent
- Contributor
- GitLab Staff
- GitLab Staff - Explore
- Light agent
- Security Staff
- Support Managers
- Support Staff
- Support Staff - CMOC
- Support Staff - Explore
- Tech Support
Zendesk US Government
- Admin
- Chat-only agent
- Contributor
- GitLab Staff
- Light agent
- Support Managers
- Support US Federal Staff
- Support US Federal Staff w/ Explore
Creating a role as a non-admin
For the creation of a role, please create a Feature Request issue (as it will require manual intervention by the Customer Support Operations team).
Editing a role as a non-admin
For the modification of a role, please create a Feature Request issue (as it will require manual intervention by the Customer Support Operations team).
Deleting a role as a non-admin
To request the deactivation of a role, please create a Feature Request issue (as it will require manual intervention by the Customer Support Operations team).
Requesting a role change
All Zendesk role changes follow this approval process:
- Submit Request: File an access request issue
- Manager Approval: The requester’s manager must approve the request
- Security Review: A Fullstack Engineer, Customer Support Operations reviews the business justification
- Decision: If approved, Customer Support Operations will make the needed changes
Administrator tasks
Note
- All sections in this section require
Administratorlevel access to Zendesk.
Viewing roles in Zendesk
To view roles in Zendesk:
- Navigate to the admin dashboard for the Zendesk instance
- Go to
People > Team > Roles
You can click on the role’s name if you need to see the permissions and membership of a role.
Creating a role
Danger
- This should only be done if there is a corresponding request issue (Feature Request, Administrative, Bug, etc.). If one does not exist, you should first create one (and let it go through the standard process before working it).
To create a role in Zendesk:
- Access the roles page
- Click
Create roleat the top-right of the page - Fill out a name for the new role
- Fill out a description for the new role (optional)
- Fill out the various permission information as needed for the new role
- Click
Create roleon the bottom-right of the page.
Editing a role
Danger
- This should only be done if there is a corresponding request issue (Feature Request, Administrative, Bug, etc.). If one does not exist, you should first create one (and let it go through the standard process before working it).
- This can severely impact agents’ ability to do their jobs. Exercise caution in doing this.
- Never change a role’s name. It can have many severe downstream effects.
To edit a role in Zendesk:
- Access the roles page
- Click the name of the role to edit
- Make the needed changes on the role
- Click
Saveon the bottom-right of the page.
Changing an agent’s role
Danger
- This requires an access request issue. Do not proceed without one.
- This requires the requester’s manager’s approval to proceed. Do not proceed without one.
Note
- If this is for a Support or Customer Support Operations team member, you might need to also update their Support team YAML file.
To change the role of an agent in Zendesk:
- Navigate to the admin dashboard for the Zendesk instance
- Go to
People > Team > Team members - Search for the person in question using their email address
- Click their name
- Click the drop-down to the right of the
Supportproduct and select the new role to use - Click
Saveat the bottom-right of the page
Deleting a role
Danger
- This should only be done if there is a corresponding request issue (Feature Request, Administrative, Bug, etc.). If one does not exist, you should first create one (and let it go through the standard process before working it).
- Keep in mind you may need to edit the Agent sync as well
- This can severely impact agents’ ability to do their jobs. Exercise caution in doing this.
To delete a role in Zendesk:
- Access the roles page
- Click the name of the role to delete
- Click
Actionson the top-right of the page - Click
Delete role - Click
Delete roleon the confirmation pop-up to confirm the deletion
Common issues and troubleshooting
This is a living section that will have items added to it as needed.
f895738e)
