Module: Slack::Web::Api::Endpoints::AdminConversationsRestrictaccess

Included in:
Slack::Web::Api::Endpoints
Defined in:
lib/slack/web/api/endpoints/admin_conversations_restrictAccess.rb

Instance Method Summary collapse

Instance Method Details

#admin_conversations_restrictAccess_addGroup(options = {}) ⇒ Object

Add an allowlist of IDP groups for accessing a channel

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :channel_id (Object) —

    The channel to link this group to.

  • :group_id (Object) —

    The IDP Group ID to be an allowlist for the private channel.

  • :team_id (Object) —

    The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.

Raises:

  • (ArgumentError)

See Also:



20
21
22
23
24
 
# File 'lib/slack/web/api/endpoints/admin_conversations_restrictAccess.rb', line 20

def admin_conversations_restrictAccess_addGroup(options = {})
  raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
  raise ArgumentError, 'Required arguments :group_id missing' if options[:group_id].nil?
  post('admin.conversations.restrictAccess.addGroup', options)
end

#admin_conversations_restrictAccess_listGroups(options = {}) ⇒ Object

List all IDP Groups linked to a channel

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :channel_id (Object) —

    .

  • :team_id (Object) —

    The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.

Raises:

  • (ArgumentError)

See Also:



35
36
37
38
 
# File 'lib/slack/web/api/endpoints/admin_conversations_restrictAccess.rb', line 35

def admin_conversations_restrictAccess_listGroups(options = {})
  raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
  post('admin.conversations.restrictAccess.listGroups', options)
end

#admin_conversations_restrictAccess_removeGroup(options = {}) ⇒ Object

Remove a linked IDP group linked from a private channel

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :channel_id (Object) —

    The channel to remove the linked group from.

  • :group_id (Object) —

    The IDP Group ID to remove from the private channel.

  • :team_id (Object) —

    The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.

Raises:

  • (ArgumentError)

See Also:



51
52
53
54
55
56
 
# File 'lib/slack/web/api/endpoints/admin_conversations_restrictAccess.rb', line 51

def admin_conversations_restrictAccess_removeGroup(options = {})
  raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
  raise ArgumentError, 'Required arguments :group_id missing' if options[:group_id].nil?
  raise ArgumentError, 'Required arguments :team_id missing' if options[:team_id].nil?
  post('admin.conversations.restrictAccess.removeGroup', options)
end