Click or drag to resize

GroupResources Interface

This interface provides methods to access Group resources.

Thread Safety: Implementation of this interface must be thread safe.

Namespace:  Smartsheet.Api
Assemblies:   smartsheet-csharp-sdk (in smartsheet-csharp-sdk.dll) Version: 2.126.0
  smartsheet-csharp-sdk (in smartsheet-csharp-sdk.dll) Version: 2.126.0
Syntax
Copy
public interface GroupResources

The GroupResources type exposes the following members.

Methods
  NameDescription
Public methodAddGroupMembers

Adds one or more members to a Group.

Remarks

If called with a single GroupMember object, and that group member already exists, error code 1129 will be returned. If called with an array of GroupMember objects any users specified in the array that are already group members will be ignored and omitted from the response.

This operation is only available to group administrators and system administrators.

This operation is asynchronous, meaning the users may not yet have sharing access to sheets for a period of time after this operation returns. For small groups with limited sharing, the operation should complete quickly (within a few seconds). For large groups with many shares, this operation could possibly take more than a minute to complete.

It mirrors to the following Smartsheet REST API method: POST /groups/{groupId}/members

Public methodCreateGroup

Creates a new Group.

It mirrors to the following Smartsheet REST API method: POST /groups

Remarks
This operation is only available to group administrators and system administrators.
Public methodDeleteGroup

Deletes the Group specified in the URL.

Remarks
This operation is only available to system administrators.

It mirrors to the following Smartsheet REST API method: DELETE /groups/{groupId}

Public methodGetGroup

Gets the Group specified in the URL.

It mirrors to the following Smartsheet REST API method: GET /groups/{groupId}

Public methodListGroups

List all Users.

It mirrors to the following Smartsheet REST API method: GET /groups

Remarks
This operation supports pagination of results. For more information, see Paging.
Public methodRemoveGroupMember

Removes a member from a Group.

Remarks

This operation is only available to group administrators and system administrators.

This operation is asynchronous, meaning group members may retain their sharing access for a brief period of time after the call returns. For small groups with limited sharing, the operation should complete quickly (within a few seconds). For large groups with many shares, this operation could possibly take more than a minute to complete.

It mirrors to the following Smartsheet REST API method: DELETE /groups/{groupId}/members/{userId}

Public methodUpdateGroup

Updates the Group specified in the URL.

It mirrors to the following Smartsheet REST API method: PUT /groups/{groupId}

Remarks
This operation is only available to group administrators and system administrators.
Top
See Also