Work with User Groups
The following are Apex classes for the Slack usergroups API methods.
Represents a group of users.
Usage
See Slack's usergroup object type.
The following are methods for Usergroup.
Signature
Return Value
Type: String
Signature
Return Value
Type: Integer
Signature
Return Value
Type: String
Signature
Return Value
Type: Integer
Signature
Return Value
Type: Integer
Signature
Return Value
Type: Integer
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Return Value
Type: Slack.Usergroup.Prefs
Signature
Return Value
Type: String
Signature
Return Value
Type: String
Signature
Return Value
Type: Integer
Signature
Return Value
Type: List<String>
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Return Value
Type: Boolean
Signature
Parameters
autoProvision
Type: Boolean
Return Value
Type: void
Signature
Parameters
autoType
Type: String
Return Value
Type: void
Signature
Parameters
channelCount
Type: Integer
Return Value
Type: void
Signature
Parameters
createdBy
Type: String
Return Value
Type: void
Signature
Parameters
dateCreate
Type: Integer
Return Value
Type: void
Signature
Parameters
dateDelete
Type: Integer
Return Value
Type: void
Signature
Parameters
dateUpdate
Type: Integer
Return Value
Type: void
Signature
Parameters
deletedBy
Type: String
Return Value
Type: void
Signature
Parameters
description
Type: String
Return Value
Type: void
Signature
Parameters
enterpriseSubteamId
Type: String
Return Value
Type: void
Signature
Parameters
external
Type: Boolean
Return Value
Type: void
Signature
Parameters
handle
Type: String
Return Value
Type: void
Signature
Parameters
id
Type: String
Return Value
Type: void
Signature
Parameters
name
Type: String
Return Value
Type: void
Signature
Parameters
prefs
Type: Slack.Usergroup.Prefs
Return Value
Type: void
Signature
Parameters
subteam
Type: Boolean
Return Value
Type: void
Signature
Parameters
teamId
Type: String
Return Value
Type: void
Signature
Parameters
updatedBy
Type: String
Return Value
Type: void
Signature
Parameters
userCount
Type: Integer
Return Value
Type: void
Signature
Parameters
usergroup
Type: Boolean
Return Value
Type: void
Signature
Parameters
users
Type: List<String>
Return Value
Type: void
Represent the default channels and groups (private channels) that members are invited to when they join.
Usage
See Slack's usergroup object type.
The following are methods for Usergroup.Prefs.
Signature
Return Value
Type: List<String>
Signature
Return Value
Type: List<String>
Signature
Parameters
channels
Type: List<String>
Return Value
Type: void
Signature
Parameters
groups
Type: List<String>
Return Value
Type: void
Sends a request to create a user group.
The following are methods for UsergroupsCreateRequest.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.UsergroupsCreateRequest.Builder.
Sends a request to create a user group.
The following are methods for UsergroupsCreateRequest.Builder. These methods are optional unless specified otherwise.
Required. Builds an instance of Slack.UsergroupsCreateRequest.
Signature
Return Value
Type: Slack.UsergroupsCreateRequest
Signature
Parameters
channels
Type: List<String>
Return Value
Type: Slack.UsergroupsCreateRequest.Builder
Signature
Parameters
description Type: String
Return Value
Type: Slack.UsergroupsCreateRequest.Builder
Signature
Parameters
handle Type: String
Return Value
Type: Slack.UsergroupsCreateRequest.Builder
Signature
Parameters
includeCount Type: Boolean
Return Value
Type: Slack.UsergroupsCreateRequest.Builder
Required. A name for the User Group. Must be unique among User Groups.
Signature
Parameters
name Type: String
Return Value
Type: Slack.UsergroupsCreateRequest.Builder
Signature
Parameters
teamId
Type: String
Return Value
Type: Slack.UsergroupsCreateRequest.Builder
Creates a user group.
This class contains standard response methods.
The following are methods for UsergroupsCreateResponse.
Signature
Return Value
Type: Slack.Usergroup
Signature
Parameters
usergroup
Type: Slack.Usergroup
Sends a request to disable an existing user group.
The following are methods for UsergroupsDisableRequest.Builder. These methods are optional unless specified otherwise.
Required. Builds an instance of Slack.UsergroupsDisableRequest.
Signature
Return Value
Type: Slack.UsergroupsDisableRequest
Signature
Parameters
includeCount
Type: Boolean
Return Value
Type: Slack.UsergroupsDisableRequest.Builder
Required. The ID of the user group to disable.
Signature
Parameters
usergroup Type: String
Return Value
Type: Slack.UsergroupsDisableRequest.Builder
Signature
Parameters
teamId
Type: String
Return Value
Type: Slack.UsergroupsDisableRequest.Builder
Sends a request to disable an existing user group.
The following are methods for UsergroupsDisableRequest.
Signature
Return Value
Type: Slack.UsergroupsDisableRequest.Builder
Disables an existing user group.
This class contains standard response methods.
The following are methods for UsergroupsDisableResponse.
Signature
Return Value
Type: Slack.Usergroup
Signature
Parameters
usergroup
Type: Slack.Usergroup
Return Value
Type: void
Sends a request to enable a user group.
The following are methods for UsergroupsEnableRequest.Builder. These methods are optional unless specified otherwise.
Required. Builds an instance of Slack.UsergroupsEnableRequest.
Signature
Return Value
Type: Slack.UsergroupsEnableRequest
Signature
Parameters
includeCount Type: Boolean
Return Value
Type: Slack.UsergroupsEnableRequest.Builder
Required. The ID of the user group to enable.
Signature
Parameters
usergroup Type: String
Return Value
Type: Slack.UsergroupsEnableRequest.Builder
Sends a request to enable a user group.
The following are methods for UsergroupsEnableRequest.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.UsergroupsEnableRequest.Builder
Signature
Parameters
teamId
Type: String
Return Value
Type: Slack.UsergroupsEnableRequest.Builder
Enables a user group.
This class contains standard response methods.
The following are methods for UsergroupsEnableResponse.
Signature
Return Value
Type: Slack.Usergroup
Signature
Parameters
usergroup
Type: Slack.Usergroup
Return Value
Type: void
Sends a request to list all user groups for a team.
The following are methods for UsergroupsListRequest.Builder. These methods are optional unless specified otherwise.
Required. Builds an instance of Slack.UsergroupsListRequest.
Signature
Return Value
Type: Slack.UsergroupsListRequest
Signature
Parameters
includeCount Type: Boolean
Return Value
Type: Slack.UsergroupsListRequest.Builder
Signature
Parameters
includeDisabled Type: Boolean
Return Value
Type: Slack.UsergroupsListRequest.Builder
Signature
Parameters
includeUsers Type: Boolean
Return Value
Type: Slack.UsergroupsListRequest.Builder
Signature
Parameters
teamId
Type: String
Return Value
Type: Slack.UsergroupsListRequest.Builder
Sends a request to list all user groups for a team.
The following are methods for UsergroupsListRequest.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.UsergroupsListRequest.Builder
Lists all user groups for a team.
This class contains standard response methods.
The following are methods for UsergroupsListResponse.
Signature
Return Value
Type: List<Slack.Usergroup>
Signature
Parameters
usergroups
Type: List<Slack.Usergroup>
Return Value
Type: void
Sends a request to update the list of users for a user group.
The following are methods for UsergroupsUpdateRequest.Builder. These methods are optional unless specified otherwise.
Required. Builds an instance of Slack.UsergroupsUpdateRequest.
Signature
Return Value
Type: Slack.UsergroupsUpdateRequest
Signature
Parameters
channels
Type: List<String>
Return Value
Type: Slack.UsergroupsUpdateRequest.Builder
Signature
Parameters
description
Type: String
Return Value
Type: Slack.UsergroupsUpdateRequest.Builder
Signature
Parameters
handle
Type: String
Return Value
Type: Slack.UsergroupsUpdateRequest.Builder
Signature
Parameters
includeCount
Type: Boolean
Return Value
Type: Slack.UsergroupsUpdateRequest.Builder
Parameters
name
Type: String
Signature
Return Value
Type: Slack.UsergroupsUpdateRequest.Builder
Signature
Parameters
teamId
Type: String
Return Value
Type: Slack.UsergroupsUpdateRequest.Builder
Required. The ID of the user group to update.
Signature
Parameters
usergroup
Type: String
Return Value
Type: Slack.UsergroupsUpdateRequest.Builder
Sends a request to update the list of users for a user group.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.UsergroupsUpdateRequest.Builder
Updates the list of users for a user group.
This class contains standard response methods.
The following are methods for UsergroupsUpdateResponse.
Signature
Return Value
Type: Slack.Usergroup
Signature
Parameters
usergroup
Type: Slack.Usergroup
Sends a request to list all users in a user group.
The following are methods for UsergroupsUsersListRequest.Builder. These methods are optional unless specified otherwise.
Required. Builds an instance of Slack.UsergroupsUsersListRequest.
Signature
Return Value
Type: Slack.UsergroupsUsersListRequest
Signature
Parameters
includeDisabled
Type: Boolean
Return Value
Type: Slack.UsergroupsUsersListRequest.Builder
Signature
Parameters
teamId
Type: String
Return Value
Type: Slack.UsergroupsUsersListRequest.Builder
Required. The ID of the user group to list.
Signature
Parameters
usergroup
Type: String
Return Value
Type: Slack.UsergroupsUsersListRequest.Builder
Sends a request to list all users in a user group.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.UsergroupsUsersListRequest.Builder
Lists all users in a user group.
This class contains standard response methods.
The following are methods for UsergroupsUsersListResponse.
Signature
Return Value
Type: List<String>
Signature
Parameters
users
Type: String
Return Value
Type: void
Sends a request to update the list of users for a user group.
The following are methods for UsergroupsUsersUpdateRequest.Builder. These methods are optional unless specified otherwise.
Required. Builds an instance of Slack.UsergroupsUsersUpdateRequest.
Signature
Return Value
Type: Slack.UsergroupsUsersUpdateRequest
Signature
Parameters
includeCount
Type: Boolean
Return Value
Type: Slack.UsergroupsUsersUpdateRequest.Builder
Signature
Parameters
teamId
Type: String
Return Value
Type: Slack.UsergroupsUsersUpdateRequest.Builder
Required. The ID of the user group to update.
Signature
Parameters
usergroup
Type: String
Return Value
Type: Slack.UsergroupsUsersUpdateRequest.Builder
Required. A comma-separated string of encoded user IDs that represent the entire list of users for the user group.
Signature
Parameters
users
Type: List<String>
Return Value
Type: Slack.UsergroupsUsersUpdateRequest.Builder
Sends a request to update the list of users for a user group.
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.UsergroupsUsersUpdateRequest.Builder
Updates the list of users for a user group.
This class contains standard response methods.
The following are methods for UsergroupsUsersUpdateResponse.
Signature
Return Value
Type: Slack.Usergroup
Signature
Parameters
usergroup
Type: Slack.Usergroup