You must enable javascript in order to use Slack. You can do this in your browser settings.

admin.users.session.reset

Wipes all valid sessions on all devices for a given user

Facts

Method URL:https://slack.com/api/admin.users.session.reset
Preferred HTTP method:POST
Accepted content types:application/x-www-form-urlencoded, application/json
Rate limiting:Tier 2
Works with:
Token typeRequired scope(s)
useradmin.users:write 

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

By default, this method resets all sessions for a given user. Use the web_only and mobile_only parameters to wipe only web or only mobile sessions.

This API method for admins may only be used on Enterprise Grid.

Arguments

token

Authentication token bearing required scopes.

Examplexxxx-xxxxxxxxx-xxxx
user_id

The ID of the user to wipe sessions for

ExampleW12345678
mobile_only

Only expire mobile sessions (default: false)

Exampletrue
web_only

Only expire web sessions (default: false)

Exampletrue

This method supports application/json via HTTP POST. Present your token in your request's Authorization header. Learn more.

Here's an example call to this endpoint:

{
  "token": "xoxp-xxxxxxxx-xxxxxxxx",
  "user_id": "U1234",
  "mobile_only": true
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.

ErrorDescription
user_not_found

Error fetching user

cannot_reset_bot

Cannot reset bot users

user_session_reset_failed

There was an error starting the session reset. Try again.

not_an_admin

This method is only accessible by org/compliance team owners and admins

unknown_method

This method is currently not available

feature_not_enabled

This method is not available for this product level

cannot_reset_primary_owner

Only primary owner can reset primary owner's sessions

invalid_auth

Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.

not_authed

No authentication token provided.

account_inactive

Authentication token is for a deleted user or workspace.

token_revoked

Authentication token is for a deleted user or workspace or the app has been removed.

no_permission

The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.

org_login_required

The workspace is undergoing an enterprise migration and will not be available until migration is complete.

ekm_access_denied

Administrators have suspended the ability to post a message.

missing_scope

The token used is not granted the specific scope permissions required to complete this request.

not_allowed_token_type

The token type used in this request is not allowed.

is_bot

This method cannot be called by a bot user.

invalid_arguments

The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.

invalid_arg_name

The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.

invalid_charset

The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.

invalid_form_data

The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.

invalid_post_type

The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.

missing_post_type

The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.

team_added_to_org

The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.

ratelimited

The request has been ratelimited. Refer to the Retry-After header for when to retry the request.

request_timeout

The method was called via a POST request, but the POST data was either missing or truncated.

service_unavailable

The service is temporarily unavailable

fatal_error

The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.

internal_error

The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.

Warnings

This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

WarningDescription
missing_charset

The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.

superfluous_charset

The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous.

Was this page helpful?