Class: SlackWebApi::AdminUsersSessionController

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

Overview

AdminUsersSessionController

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_users_session_invalidate(token, team_id, session_id) ⇒ ApiResponse

Invalidate a single session for a user by session_id scope: admin.users:write session belongs to here

Parameters:

  • token (String) —

    Required parameter: Authentication token. Requires

  • team_id (String) —

    Required parameter: ID of the team that the

  • session_id (Integer) —

    Required parameter: TODO: type description

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/slack_web_api/controllers/admin_users_session_controller.rb', line 17

def admin_users_session_invalidate(token,
                                   team_id,
                                   session_id)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/admin.users.session.invalidate',
                                 Server::DEFAULT)
               .header_param(new_parameter(token, key: 'token')
                              .is_required(true))
               .form_param(new_parameter(team_id, key: 'team_id')
                            .is_required(true))
               .form_param(new_parameter(session_id, key: 'session_id')
                            .is_required(true))
               .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
               .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

#admin_users_session_reset(token, user_id, mobile_only: nil, web_only: nil) ⇒ ApiResponse

Wipes all valid sessions on all devices for a given user scope: admin.users:write sessions for expire mobile sessions (default: false) web sessions (default: false)

Parameters:

  • token (String) —

    Required parameter: Authentication token. Requires

  • user_id (String) —

    Required parameter: The ID of the user to wipe

  • mobile_only (TrueClass | FalseClass) (defaults to: nil) —

    Optional parameter: Only

  • web_only (TrueClass | FalseClass) (defaults to: nil) —

    Optional parameter: Only expire

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/slack_web_api/controllers/admin_users_session_controller.rb', line 53

def admin_users_session_reset(token,
                              user_id,
                              mobile_only: nil,
                              web_only: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/admin.users.session.reset',
                                 Server::DEFAULT)
               .header_param(new_parameter(token, key: 'token')
                              .is_required(true))
               .form_param(new_parameter(user_id, key: 'user_id')
                            .is_required(true))
               .form_param(new_parameter(mobile_only, key: 'mobile_only'))
               .form_param(new_parameter(web_only, key: 'web_only'))
               .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
               .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