Admin dashboard
Get started with the Hoppscotch Admin Dashboard.
The Admin Dashboard serves as the central hub for managing your workspace and user-related activities. From here, you can efficiently oversee and control various aspects of your platform.
The Users section empowers you to effectively control user-related actions. It streamlines the process of user management, making it simple to oversee the user base.
You can replace
- Insights Dashboard: Gain valuable insights into platform usage.
- Manage Users: Handle user-related actions, such as inviting, elevating admins, and deleting users.
- Manage Workspaces: Create, edit, and delete workspaces while managing workspace-specific details and user memberships.
Dashboard
The Dashboard section provides an overview of essential metrics and statistics regarding users, workspace, and activity. This snapshot allows you to track the usage and performance of your platform. Get insights into your organization’s usage of Hoppscotch.- Number of Users: Monitor the count of registered users.
- Number of Workspaces: Keep track of the total number of workspaces.
- Number of Requests: Measure the volume of requests made by your organization.
- Number of Collections: Track the quantity of collections within the platform.
Manage users
In Hoppscotch enterprise edition, a user needs to be explicitly invited by the admin to create an account on the platform.
- User List: View a comprehensive list of all users and their activity on your platform
- Invite Users: Send invitations to new users, welcoming them to the platform.
- Admin Privileges: Elevate users to administrative roles for increased permissions.
- User Deletion: Delete users when necessary.
Invite Users to your Hoppscotch Instance
Admins can easily bring new users to their Hoppscotch instance by sending them invitations. Depending on whether SMTP is configured, the process differs slightly. Here’s how you can invite users:- With SMTP Configured
When SMTP is enabled from the admin dashboard and the required SMTP configurations are correctly set, follow these steps to invite a new user:- Go to the Users section within the Admin Dashboard.
- Select the Invite User button to open the invitation modal.
- Input the email address of the user you want to invite and click Add User to send an invitation.
- An email containing an invite link (
http://localhost:3000) will be sent to the invitee. They can use this link to log in to Hoppscotch web app. - Alternatively, you can copy the invite link and share it through other platforms with the new user, but make sure the user signs in using the email address specified during the invitation process.
- Without SMTP Configured
If SMTP is disabled from the admin dashboard, the invitation process is slightly different:- Go to the Users section within the Admin Dashboard.
- Select the Invite User button to open the invitation modal.
- Input the email address of the user you want to invite and click Add User.
- An invite link (
http://localhost:3000) will be generated and displayed before you. Copy this link and share it with the user via your preferred communication channel. Make sure that the user signs in to Hoppscotch using the same email address you provided during the invitation.
Pending Invites
Within the Users section, admins can view a list of all users who have been invited but have not yet joined the organization. To access this list, simply click on the Pending Invites button next to “Invite User”. Here, you’ll see all the invitations you’ve sent, along with details such as:- Invitee Email: The email address to which the invite was sent.
- Invited By: The email address of the user who sent the invitation
- Invited on: The date and time when the invitation was sent.
- Copy Invite Link: If you need to resend the invitation, you can easily
copythe invite link and share it with the user via any communication platform. - Revoke Invitation: If you wish to cancel an invitation, simply click the
Revoke Invitationbutton next to the specific user invite in the Action column. This will remove the pending invite from the list and prevent the user from accessing your Hoppscotch instance using that link.
APIs for User Management
The RESTful APIs designed for User Management enable admins to perform a wide range of user-related actions, such as inviting new users, deleting existing ones, and updating user details. These APIs provide admins with the ability to efficiently manage user accounts and permissions. The table below introduces nine key APIs that empower admins with greater control over user management.| User Activity | Description | Method | Endpoint |
|---|---|---|---|
| Invite a New User | Allows admins to invite a new user to the instance. | POST | <base-url>/v1/infra/user-invitations |
| View Pending Invites | Retrieves a list of all pending invites sent to new users. | GET | <base-url>/v1/infra/user-invitations |
| Delete Pending Invites | Enables admins to delete specific pending invites using their Email ID. | DELETE | <base-url>/v1/infra/user-invitations |
| View All Users | Provides a list of all users in the instance. | GET | <base-url>/v1/infra/users |
| View a Particular User | Fetches details of a specific user in the instance by their User ID. | GET | <base-url>/v1/infra/users/{uid} |
| Delete an existing User | Enables admins to delete an existing user from the instance by their User ID. | DELETE | <base-url>/v1/infra/users/{uid} |
| Update User Details | Allows admins to update the details of an existing user. | PATCH | <base-url>/v1/infra/users/{uid} |
| Manage Admin Status | Enables admins to add or remove admin status for an existing user. | PATCH | <base-url>/v1/infra/users/{uid}/admin-status |
| Fetch User’s involvement in Workspaces | Retrieves workspace details that a user is part of, including their role. | GET | <base-url>/v1/infra/users/{uid}/workspaces |
| Deactivate User Account | Allows admins to deactivate a user account, preventing them from accessing the instance until reactivated. | POST | <base-url>/v1/infra/users/{uid}/deactivate |
| Reactivate User Account | Allows admins to activate a user account that was previously deactivated. | POST | <base-url>/v1/infra/users/{uid}/reactivate |
To interact with the User Management APIs, ensure that your backend service is running, either on your local machine or on a server. The API documentation is accessible at the
/api-docs endpoint relative to your backend service URL. For example, if your backend is running locally, you can access the API docs at http://localhost:3170/api-docs. You can also retrieve the OpenAPI v3 JSON format at http://localhost:3170/api-docs-json. Infra-tokens
InfraTokens are special UUID tokens that provide a secure way for admins to interface with Self-Hosted APIs. They are exclusively accessible to admins, ensuring that only authorized personnel can manage sensitive operations. Unlike Personal Access Tokens, which are tied to individual users, InfraTokens are scoped at the instance level, granting access to all admins within the instance.Steps to Generate an InfraToken
Follow these steps to create a new InfraToken:- After logging into your Self-Hosted instance using your admin credentials, you can access the “Infra Tokens” under the “Settings” section from your admin dashboard.
- Click on “Generate new token.”
- Enter a title for the token and select an expiration date. Available options include 7 days, 30 days, 60 days, 90 days, or no expiry.
- After providing the necessary details, confirm the creation. The new InfraToken will be displayed once, make sure to copy it securely to your clipboard for immediate use.
- If you decide that you no longer need the token, you can delete it by navigating back to “Infra Tokens” section.
The details of the admin who created the InfraToken are stored for audit purposes. All admins can view and manage these tokens.
How to Use InfraTokens
InfraTokens are to be used as Bearer tokens. When making requests to the User Management APIs, include theInfraToken in the Authorization header as follows:
Manage Workspaces
In the Manage Workspace section, you can efficiently handle workspace-related operations, ensuring that collaborations and projects run smoothly.- Workspace Creation: Establish new workspaces tailored to specific projects or departments.
- Workspace Editing: Modify workspace details and configurations as needed.
- Workspace Deletion: Disband workspaces that are no longer relevant.
- User Memberships: View and manage the users associated with each workspace.
APIs for Workspace Management
We’ve introduced new APIs to make workspace management and collaboration easier for admins. These APIs enable quick actions like creating new workspaces, updating existing workspace details, and deleting workspaces as needed. Check out the table below for fourteen APIs that give admins a greater control over managing Hoppscotch workspaces.| Workspace Activity | Description | Method | Endpoint |
|---|---|---|---|
| Create a Workspace | Create a new workspace within the instance. | POST | <base-url>/v1/infra/workspaces |
| View All Workspaces | Retrieves a list of all workspaces available. | GET | <base-url>/v1/infra/workspaces |
| View Workspace Details | List details about a specific workspace like name, members, roles, and pending invites. | GET | <base-url>/v1/infra/workspaces/{id} |
| Delete a workspace | Remove an existing workspace using its ID. | DELETE | <base-url>/v1/infra/workspaces/{id} |
| Update details for an existing workspace. | Modify settings and preferences for an existing workspace. | PATCH | <base-url>/v1/infra/workspaces/{id} |
| List Members of a Workspace | Retrieves a list of all members in a specific workspace. | GET | <base-url>/v1/infra/workspaces/{id}/ members |
| Get Workspace Owners count | Fetches number of Workspace members with “OWNER” permissions | GET | <base-url>/v1/infra/workspaces/{id}/ owners-count |
| Get Workspace Editors count | Fetches number of Workspace members with “EDITOR” permissions | GET | <base-url>/v1/infra/workspaces/{id}/ editors-count |
| Get Workspace Viewers count | Fetches number of Workspace members with “VIEWER” permissions | GET | <base-url>/v1/infra/workspaces/{id}/ viewers-count |
| Add User to a workspace | Add a user and assign roles (Owner, Editor, and Viewer) in a workspace. | POST | <base-url>/v1/infra/workspaces/{id}/ user |
| Change User roles in a workspace | Update the role (Owner, Editor, and Viewer) of a user within a workspace | PATCH | <base-url>/v1/infra/workspaces/{id}/ user/{uid}/role |
| Remove User from a workspace | Remove a user from a workspace using their ID | DELETE | <base-url>/v1/infra/workspaces/{id}/ user/{uid} |
| View all pending workspace invites. | List all pending invites for workspace access. | GET | <base-url>/v1/infra/workspaces/{id}/ invitations |
| Delete pending workspace invites. | Revoke Workspace invitations using invitation IDs. | DELETE | <base-url>/v1/infra/workspaces/{id}/ invitations/{invitation_id} |
To interact with the Workspace Management APIs, ensure that your backend service is running, either on your local machine or on a server. The API documentation is accessible at the
/api-docs endpoint relative to your backend service URL. For example, if your backend is running locally, you can access the API docs at http://localhost:3170/api-docs. You can also retrieve the OpenAPI v3 JSON format at http://localhost:3170/api-docs-json. Server Settings
In the Server Settings section, you have the ability to both view and edit the environment variables that were configured during the setup of your self-hosted instance.Configurations
-
Access Control Settings: Manage and restrict user access to ensure only authorized users can interact with your Hoppscotch instance.
- Site Protection: When site protection is activated, all visitors to your Hoppscotch instance will be prompted to create an account and log in to use Hoppscotch. Site protection is enabled by default on Hoppscotch Enterprise and can be disabled as needed.
- Domain Whitelisting: Domain Whitelisting enables organization admins to grant access to users with email addresses under the organization’s domain without explicit approval.
- Configure Authentication Providers: Customize authentication providers, including Google, Microsoft, GitHub, and email, directly from the settings page.
- Configure SMTP Settings: Configure your SMTP settings for seamless email integration.
- Configure SAML Settings: Configure your SAML settings for your SAML based Single sign on.
- Configure OIDC Settings: Configure your OIDC Settings for Single Sign-On based authentication.
- User Provisioning: Enable SCIM provisioning to manage user creation, updates, and deprovisioning directly from your Identity Provider (IdP). Learn how to set up SCIM provisioning in Hoppscotch and Okta.
- Configure Logging Settings: Manage activity and audit logging configurations for your Hoppscotch instance. Enable or disable logs through a unified setting, configure ClickHouse credentials, and download audit logs in CSV format.
-
History Configurations:
Control the logging of request history for all users with a simple toggle option.
- When enabled: Request history is visible in the Hoppscotch app, and new entries are actively logged and stored in the database.
- When disabled: Request history is hidden from the Hoppscotch app, and no new request logs are written to the database.
- Data sharing: Enable or disable anonymous data sharing to help improve Hoppscotch. Learn more about the metrics collected.
- Reset Configurations: If needed, reset your configurations back to their original state.
Custom Banner
Custom banners allow self-host admin to share important announcements such as a scheduled maintenance or instance upgrade with the rest of your team.-
Create Announcements: Navigate to the
Bannerstab and toggle the “Show Banner” action. Select the type of banner (Information, Warning, or Danger), craft and preview the message content, andsaveit to activate announcement immediately. - Edit Announcements: You can modify the announcements directly by editing the message or changing the banner type and further saving the changes to implement them.
- Delete Announcements: Manually end an announcement by toggling the “Show Banner” action OFF.
License Settings
The License Settings enable you to both configure and view your enterprise license information. You have the following options:- Edit and Configure License Key: You can modify and configure your license key as needed.
- View License Status: Obtain insights into the current status of your license. This includes details such as License Status, Issued to, Number of seats purchased, and expiry date.
Hard Reset Configurations
If you need to perform a hard reset of the server configurations, execute the following command in your terminal to reset all your environment variables:<db_container_id> with the actual ID of your Docker container.