speatzle/go-passbolt
1
0
Fork 0
mirror of https://github.com/passbolt/go-passbolt.git synced 2025-05-09 17:48:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

improve group support

Browse source
This commit is contained in:
Samuel Lorch 2021-09-02 09:27:45 +02:00
parent 19533e3409
commit 0731d52273
1 changed files with 70 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

81
api/groups.go
View file

@ -7,14 +7,30 @@ import (
//Group is a Group //Group is a Group
type Group struct { type Group struct {
ID string `json:"id,omitempty"` ID string `json:"id,omitempty"`
Name string `json:"name,omitempty"` Name string `json:"name,omitempty"`
Created *Time `json:"created,omitempty"` Created *Time `json:"created,omitempty"`
CreatedBy string `json:"created_by,omitempty"` CreatedBy string `json:"created_by,omitempty"`
Deleted bool `json:"deleted,omitempty"` Deleted bool `json:"deleted,omitempty"`
Modified *Time `json:"modified,omitempty"` Modified *Time `json:"modified,omitempty"`
ModifiedBy string `json:"modified_by,omitempty"` ModifiedBy string `json:"modified_by,omitempty"`
GroupUsers []User `json:"groups_users,omitempty"` GroupUsers []GroupMembership `json:"groups_users,omitempty"`
}
type GroupMembership struct {
ID string `json:"id,omitempty"`
UserID string `json:"user_id,omitempty"`
GroupID string `json:"group_id,omitempty"`
IsAdmin bool `json:"is_admin,omitempty"`
Delete bool `json:"delete,omitempty"`
User User `json:"user,omitempty"`
Created *Time `json:"created,omitempty"`
}
type GroupUpdate struct {
Name string `json:"name,omitempty"`
GroupChanges []GroupMembership `json:"groups_users,omitempty"`
Secrets []Secret `json:"secrets,omitempty"`
} }
// GetGroupsOptions are all available query parameters // GetGroupsOptions are all available query parameters
@ -29,6 +45,35 @@ type GetGroupsOptions struct {
ContainMyGroupUser bool `url:"contain[my_group_user],omitempty"` ContainMyGroupUser bool `url:"contain[my_group_user],omitempty"`
} }
// UpdateGroupDryRunResult is the Result of a Update Group DryRun
type UpdateGroupDryRunResult struct {
DryRun UpdateGroupDryRun `json:"dry-run,omitempty"`
}
// UpdateGroupDryRun contains the Actual Secrets Needed to update the group
type UpdateGroupDryRun struct {
// for which users the secrets need to be reencrypted
SecretsNeeded []UpdateGroupSecretsNeededContainer `json:"SecretsNeeded,omitempty"`
// secrets needed to be reencrypted
Secrets []GroupSecret `json:"Secrets,omitempty"`
}
// GroupSecret is a unnessesary container...
type GroupSecret struct {
Secret []Secret `json:"secret,omitempty"`
}
// UpdateGroupSecretsNeededContainer is a unnessesary container...
type UpdateGroupSecretsNeededContainer struct {
Secret UpdateGroupDryRunSecretsNeeded `json:"Secret,omitempty"`
}
// UpdateGroupDryRunSecretsNeeded a secret that needs to be reencrypted for a specific user
type UpdateGroupDryRunSecretsNeeded struct {
ResourceID string `json:"resource_id,omitempty"`
UserID string `json:"user_id,omitempty"`
}
// GetGroups gets all Passbolt Groups // GetGroups gets all Passbolt Groups
func (c *Client) GetGroups(ctx context.Context, opts *GetGroupsOptions) ([]Group, error) { func (c *Client) GetGroups(ctx context.Context, opts *GetGroupsOptions) ([]Group, error) {
msg, err := c.DoCustomRequest(ctx, "GET", "/groups.json", "v2", nil, opts) msg, err := c.DoCustomRequest(ctx, "GET", "/groups.json", "v2", nil, opts)
@ -74,12 +119,12 @@ func (c *Client) GetGroup(ctx context.Context, groupID string) (*Group, error) {
} }
// UpdateGroup Updates a existing Passbolt Group // UpdateGroup Updates a existing Passbolt Group
func (c *Client) UpdateGroup(ctx context.Context, groupID string, group Group) (*Group, error) { func (c *Client) UpdateGroup(ctx context.Context, groupID string, update GroupUpdate) (*Group, error) {
msg, err := c.DoCustomRequest(ctx, "PUT", "/groups/"+groupID+".json", "v2", group, nil) msg, err := c.DoCustomRequest(ctx, "PUT", "/groups/"+groupID+".json", "v2", update, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
var group Group
err = json.Unmarshal(msg.Body, &group) err = json.Unmarshal(msg.Body, &group)
if err != nil { if err != nil {
return nil, err return nil, err
@ -87,6 +132,20 @@ func (c *Client) UpdateGroup(ctx context.Context, groupID string, group Group) (
return &group, nil return &group, nil
} }
// UpdateGroupDryRun Checks that a Passbolt Group update passes validation
func (c *Client) UpdateGroupDryRun(ctx context.Context, groupID string, update GroupUpdate) (*UpdateGroupDryRunResult, error) {
msg, err := c.DoCustomRequest(ctx, "PUT", "/groups/"+groupID+"/dry-run.json", "v2", update, nil)
if err != nil {
return nil, err
}
var result UpdateGroupDryRunResult
err = json.Unmarshal(msg.Body, &result)
if err != nil {
return nil, err
}
return &result, nil
}
// DeleteGroup Deletes a Passbolt Group // DeleteGroup Deletes a Passbolt Group
func (c *Client) DeleteGroup(ctx context.Context, groupID string) error { func (c *Client) DeleteGroup(ctx context.Context, groupID string) error {
_, err := c.DoCustomRequest(ctx, "DELETE", "/groups/"+groupID+".json", "v2", nil, nil) _, err := c.DoCustomRequest(ctx, "DELETE", "/groups/"+groupID+".json", "v2", nil, nil)