Groups
Last updated
Last updated
The groups endpoint allows you to create, view, and manage Gophish groups.
This example shows how to retrieve the name and size of every group in Gophish.
Attributes
id
(int) The user ID
first_name
(str) The first name
last_name
(str) The last name
email
(str) The email address
position
(str) The position (job role)
Methods
__init__(self, **kwargs)
- Returns a new User Example:
A group contains one or more models.User
objects. The group name must be unique.
Attributes
id
(int) The group ID
targets
(list(models.User)) The group's users
name
(str) The group name
modified_date
(optional: datetime.datetime) The scheduled time for group launch
Methods
__init__(self, **kwargs)
- Returns a new Group
Example:
Gets the details for one or more groups. To get a particular group, set the ID to the group ID.
If the group_id
is not set, all groups owned by the current user will be returned.
Returns
If the group
is set: models.Group
If group_id
is None
: list(models.Group)
Creates a new group. This endpoint requires you to submit a gophish.models.Group
object.
Returns
The gophish.models.Group
object that was created.
Edits an existing group. This endpoint requires you to submit an existing gophish.models.Group
object with its id
attribute set correctly.
Returns
The gophish.models.Group
object that was edited.
Deletes the group specified by group_id
.
Returns
A gophish.models.Status
message.
Here are some examples to show how to use the API.
All of these examples assume the following setup: