Get started with the Hoppscotch Admin Dashboard.
MAILER_SMTP_ENABLE=true
) in your environment file and the required SMTP configurations for email login are correctly set, follow these steps to invite a new user:
http://localhost:3000
) will be sent to the invitee. They can use this link to log in to Hoppscotch web app.MAILER_SMTP_ENABLE=false
) in your environment file, the invitation process is slightly different:
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.copy
the invite link and share it with the user via any communication platform.Revoke Invitation
button 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.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 |
/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. InfraToken
in the Authorization
header as follows:
<db_container_id>
with the actual ID of your Docker container.