Group Users

A GroupUser is a record about membership of a User within a Group.

Creating GroupUsers

GroupUsers can be created via the normal create action. When using the update action, if the GroupUser record does not exist for the given user/group IDs it will be created.

List Group Users

SDK Method

groupuser.List()

Return Object

[]*GroupUser

Authorization Requirement

Available to all authenticated keys or sessions.

GroupUserListParams Fields

FieldDescription
GroupId
int64		Group ID. If provided, will return group_users of this group.
UserId
int64		User ID. If provided, will return group_users of this user.

Additional Arguments

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    group_user "github.com/Files-com/files-sdk-go/v3/groupuser"
)

groupUserIterator, err := group_user.List(files_sdk.GroupUserListParams{GroupId: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

for groupUserIterator.Next() {
    groupUser := groupUserIterator.groupUser()
}
err = groupUserIterator.Err()
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

Create Group User

SDK Method

groupuser.Create()

Return Object

GroupUser

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

GroupUserCreateParams Fields

FieldDescription
GroupId
int64
Required		Group ID to add user to.
UserId
int64
Required		User ID to add to group.
Admin
boolean		Is the user a group administrator?

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    group_user "github.com/Files-com/files-sdk-go/v3/groupuser"
)

groupUser, err := group_user.Create(files_sdk.GroupUserCreateParams{
  GroupId: 1,
  UserId: 1
})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

Update Group User

SDK Method

groupuser.Update()

Return Object

GroupUser

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

GroupUserUpdateParams Fields

FieldDescription
Id
int64
Required		Group User ID.
GroupId
int64
Required		Group ID to add user to.
UserId
int64
Required		User ID to add to group.
Admin
boolean		Is the user a group administrator?

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    group_user "github.com/Files-com/files-sdk-go/v3/groupuser"
)

groupUser, err := group_user.Update(files_sdk.GroupUserUpdateParams{
  Id: 1,
  GroupId: 1,
  UserId: 1,
  Admin: lib.Bool(false)
})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

Delete Group User

SDK Method

groupuser.Delete()

Return Object

No return value.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

GroupUserDeleteParams Fields

FieldDescription
Id
int64
Required		Group User ID.
GroupId
int64
Required		Group ID from which to remove user.
UserId
int64
Required		User ID to remove from group.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    group_user "github.com/Files-com/files-sdk-go/v3/groupuser"
)

err := group_user.Delete(files_sdk.GroupUserDeleteParams{
  Id: 1,
  GroupId: 1,
  UserId: 1
})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

The GroupUser Object

Some of the methods above return a GroupUser object. The attributes of this object are listed below.

AttributeDescription
GroupName
string		Group name
GroupId
int64		Group ID
UserId
int64		User ID
Admin
boolean		Is this user an administrator of this group?
Username
string		Username of the user