API Documentation
Search…
User Management
Gophish supports having multiple user accounts. Each of these accounts are separate, with their own campaigns, landing pages, templates, etc.
Each user account in Gophish is assigned a role. These are global roles that describe the user's permissions within Gophish.
At the time of this writing, there are two roles:
Role
Slug
Description
User
user
A non-administrative user role. Users with this role can create objects and launch campaigns.
Admin
admin
An administrative user. Users with this role can manage system-wide settings as well as other user accounts within Gophish.
Users have the following format:
{
id : int64
username : string
role : Role
modified_date : string(datetime)
}
Each Role has the following format:
{
name : string
slug : string
description : string
}
get
https://localhost:3333
/api/users/
Get Users
get
https://localhost:3333
/api/users/:id
Get User
post
https://localhost:3333
/api/users/
Create User
put
https://localhost:3333
/api/users/:id
Modify User
delete
https://localhost:3333
/api/users/:id
Delete User
Returns a 404 error if no user is found with the provided ID.
Last modified 3yr ago
Copy link
On this page
get
Get Users
get
Get User
post
Create User
put
Modify User
delete
Delete User