Class: SlackWebApi::AdminConversationsEkmController

Inherits:
BaseController show all
Defined in:
lib/slack_web_api/controllers/admin_conversations_ekm_controller.rb

Overview

AdminConversationsEkmController

Constant Summary

Constants inherited from BaseController

BaseController::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

#initialize, #new_parameter, #new_request_builder, #new_response_handler, user_agent, user_agent_parameters

Constructor Details

This class inherits a constructor from SlackWebApi::BaseController

Instance Method Details

#admin_conversations_ekm_list_original_connected_channel_info(token, channel_ids: nil, team_ids: nil, limit: nil, cursor: nil) ⇒ ApiResponse

List all disconnected channels—i.e., channels that were once connected to other workspaces and then disconnected—and the corresponding original channel IDs for key revocation with EKM. scope: admin.conversations:read channels to filter to. workspaces to which the channels you would like returned belong. return. Must be between 1 - 1000 both inclusive. returned by the previous call to list items in the next page.

Parameters:

  • token (String) —

    Required parameter: Authentication token. Requires

  • channel_ids (String) (defaults to: nil) —

    Optional parameter: A comma-separated list of

  • team_ids (String) (defaults to: nil) —

    Optional parameter: A comma-separated list of the

  • limit (Integer) (defaults to: nil) —

    Optional parameter: The maximum number of items to

  • cursor (String) (defaults to: nil) —

    Optional parameter: Set cursor to next_cursor

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/slack_web_api/controllers/admin_conversations_ekm_controller.rb', line 23

def admin_conversations_ekm_list_original_connected_channel_info(token,
                                                                 channel_ids: nil,
                                                                 team_ids: nil,
                                                                 limit: nil,
                                                                 cursor: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/admin.conversations.ekm.listOriginalConnectedChannelInfo',
                                 Server::DEFAULT)
               .query_param(new_parameter(token, key: 'token')
                             .is_required(true))
               .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
               .query_param(new_parameter(channel_ids, key: 'channel_ids'))
               .query_param(new_parameter(team_ids, key: 'team_ids'))
               .query_param(new_parameter(limit, key: 'limit'))
               .query_param(new_parameter(cursor, key: 'cursor'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('slackAuth')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(DefaultSuccessTemplate.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Typical error response',
                             DefaultErrorTemplateException))
    .execute
end