module Slack::Web::Api::Endpoints::AdminUsergroups

Public Instance Methods

admin_usergroups_addChannels(options = {}) click to toggle source

Add up to one hundred default channels to an IDP group.

@option options [Object] :channel_ids

Comma separated string of channel IDs.

@option options [Object] :usergroup_id

ID of the IDP group to add default channels for.

@option options [Object] :team_id

The workspace to add default channels in.

@see api.slack.com/methods/admin.usergroups.addChannels @see github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.usergroups/admin.usergroups.addChannels.json

# File lib/slack/web/api/endpoints/admin_usergroups.rb, line 20
def admin_usergroups_addChannels(options = {})
  throw ArgumentError.new('Required arguments :channel_ids missing') if options[:channel_ids].nil?
  throw ArgumentError.new('Required arguments :usergroup_id missing') if options[:usergroup_id].nil?
  post('admin.usergroups.addChannels', options)
end
admin_usergroups_addTeams(options = {}) click to toggle source

Associate one or more default workspaces with an organization-wide IDP group.

@option options [Object] :team_ids

A comma separated list of encoded team (workspace) IDs. Each workspace MUST belong to the organization associated with the token.

@option options [Object] :usergroup_id

An encoded usergroup (IDP Group) ID.

@option options [Object] :auto_provision

When true, this method automatically creates new workspace accounts for the IDP group members.

@see api.slack.com/methods/admin.usergroups.addTeams @see github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.usergroups/admin.usergroups.addTeams.json

# File lib/slack/web/api/endpoints/admin_usergroups.rb, line 37
def admin_usergroups_addTeams(options = {})
  throw ArgumentError.new('Required arguments :team_ids missing') if options[:team_ids].nil?
  throw ArgumentError.new('Required arguments :usergroup_id missing') if options[:usergroup_id].nil?
  post('admin.usergroups.addTeams', options)
end
admin_usergroups_listChannels(options = {}) click to toggle source

List the channels linked to an org-level IDP group (user group).

@option options [Object] :usergroup_id

ID of the IDP group to list default channels for.

@option options [Object] :include_num_members

Flag to include or exclude the count of members per channel.

@option options [Object] :team_id

ID of the the workspace.

@see api.slack.com/methods/admin.usergroups.listChannels @see github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.usergroups/admin.usergroups.listChannels.json

# File lib/slack/web/api/endpoints/admin_usergroups.rb, line 54
def admin_usergroups_listChannels(options = {})
  throw ArgumentError.new('Required arguments :usergroup_id missing') if options[:usergroup_id].nil?
  post('admin.usergroups.listChannels', options)
end
admin_usergroups_removeChannels(options = {}) click to toggle source

Remove one or more default channels from an org-level IDP group (user group).

@option options [Object] :channel_ids

Comma-separated string of channel IDs.

@option options [Object] :usergroup_id

ID of the IDP Group.

@see api.slack.com/methods/admin.usergroups.removeChannels @see github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.usergroups/admin.usergroups.removeChannels.json

# File lib/slack/web/api/endpoints/admin_usergroups.rb, line 68
def admin_usergroups_removeChannels(options = {})
  throw ArgumentError.new('Required arguments :channel_ids missing') if options[:channel_ids].nil?
  throw ArgumentError.new('Required arguments :usergroup_id missing') if options[:usergroup_id].nil?
  post('admin.usergroups.removeChannels', options)
end