Module: Slack::Web::Api::Endpoints::AdminAppsConfig

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

Instance Method Summary collapse

Instance Method Details

#admin_apps_config_lookup(options = {}) ⇒ Object

Look up the app config for connectors by their IDs

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :app_ids (array) —

    An array of app IDs to get app configs for.

  • :rich_link_preview_types (array) —

    return apps with the corresponding rich link preview layouts.

See Also:



18
19
20
 
# File 'lib/slack/web/api/endpoints/admin_apps_config.rb', line 18

def admin_apps_config_lookup(options = {})
  post('admin.apps.config.lookup', options)
end

#admin_apps_config_set(options = {}) ⇒ Object

Set the app config for a connector

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :app_id (Object) —

    The encoded app ID to set the app config for.

  • :workflow_auth_strategy (enum) —

    The workflow auth permission. Can be one of builder_choice or end_user_only.

  • :rich_link_preview_type (enum) —

    Indicates the app-level override for rich link preview. Unsupported for free teams.

  • :domain_restrictions (object) —

    Domain restrictions for the app. Should be an object with two properties: urls and emails. Each is an array of strings, and each sets the allowed URLs and emails for connector authorization, respectively.

Raises:

  • (ArgumentError)

See Also:



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

def admin_apps_config_set(options = {})
  raise ArgumentError, 'Required arguments :app_id missing' if options[:app_id].nil?
  post('admin.apps.config.set', options)
end