Module: Slack::Web::Api::Endpoints::AdminUsersSession

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

Instance Method Summary collapse

Instance Method Details

#admin_users_session_reset(options = {}) ⇒ Object

This method wipes a user session, leaving the user unauthenticated. The user’s Slack client will reset its local cache.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :user_id (Object) —

    The ID of the user to wipe sessions for.

  • :mobile_only (Object) —

    Only expire mobile sessions (default: false).

  • :web_only (Object) —

    Only expire web sessions (default: false).

See Also:



19
20
21
22
 
# File 'lib/slack/web/api/endpoints/admin_users_session.rb', line 19

def admin_users_session_reset(options = {})
  throw ArgumentError.new('Required arguments :user_id missing') if options[:user_id].nil?
  post('admin.users.session.reset', options)
end