Module: Slack::Web::Api::Endpoints::AdminConversationsWhitelist

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

Instance Method Summary collapse

Instance Method Details

#admin_conversations_whitelist_add(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 whitelist a group for.

  • :group_id (Object) —

    The IDP Group ID to whitelist for the private channel.

  • :team_id (Object) —

    The workspace where the IDP Group and channel exist.

See Also:



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

def admin_conversations_whitelist_add(options = {})
  throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
  throw ArgumentError.new('Required arguments :group_id missing') if options[:group_id].nil?
  logger.warn('admin.conversations.whitelist.add:  Alternative methods: .')
  post('admin.conversations.whitelist.add', options)
end

#admin_conversations_whitelist_listGroupsLinkedToChannel(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 channele exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.

See Also:



36
37
38
39
40
 
# File 'lib/slack/web/api/endpoints/admin_conversations_whitelist.rb', line 36

def admin_conversations_whitelist_listGroupsLinkedToChannel(options = {})
  throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
  logger.warn('admin.conversations.whitelist.listGroupsLinkedToChannel:  Alternative methods: .')
  post('admin.conversations.whitelist.listGroupsLinkedToChannel', options)
end

#admin_conversations_whitelist_remove(options = {}) ⇒ Object

Remove an allowlisted IDP group linked to a private channel

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel_id (Object) —

    The channel to remove a whitelisted group for.

  • :group_id (Object) —

    The IDP Group ID to remove from the private channel whitelist.

  • :team_id (Object) —

    The workspace where the IDP Group and channel exist.

See Also:



53
54
55
56
57
58
59
 
# File 'lib/slack/web/api/endpoints/admin_conversations_whitelist.rb', line 53

def admin_conversations_whitelist_remove(options = {})
  throw ArgumentError.new('Required arguments :channel_id missing') if options[:channel_id].nil?
  throw ArgumentError.new('Required arguments :group_id missing') if options[:group_id].nil?
  throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
  logger.warn('admin.conversations.whitelist.remove:  Alternative methods: .')
  post('admin.conversations.whitelist.remove', options)
end