admin.users.session.resetBulk

View other methods

Enqueues an asynchronous job to wipe all valid sessions on all devices for a given list of users

Reference docs Tester

Facts

Method access

HTTP

JavaScript

Python

Java

HTTP

POSThttps://slack.com/api/admin.users.session.resetBulk

Bolt for Java

app.client().adminUsersSessionResetBulk

Bolt for Python

app.client.admin_users_session_resetBulk

Bolt for JavaScript

app.client.admin.users.session.resetBulk

Required scopes

User tokensadmin.users:write

Content types

application/x-www-form-urlencodedapplication/json

Rate limits

Tier 2

Arguments

Required arguments

token

token

·Required

Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

Example

xxxx-xxxxxxxxx-xxxx

user_ids

array

·Required

The ID of the user to wipe sessions for

Example

["W12345678", "W98765432"]

Optional arguments

mobile_only

boolean

·Optional

Only expire mobile sessions (default: false)

Example

true

web_only

boolean

·Optional

Only expire web sessions (default: false)

Example

true

Usage info

This method enqueues a job that wipes sessions for a list of users, leaving them unauthenticated. The users' Slack clients will reset their local cache.

By default, the enqueued job will reset all sessions for the given users. Use the web_only and mobile_only parameters to wipe only web or only mobile sessions.

Note: An ok response from this endpoint does not mean all sessions have been reset. This process is asynchronous. It means that the job that performs the reset has successfully been enqueued.

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

Here's an example call to this endpoint:

{
  "token": "xoxp-xxxxxxxx-xxxxxxxx",
  "user_ids": ["U1234", "U2345", "U3456"],
  "mobile_only": true
}

Example responses

Common successful response

Typical success response

{
    "ok": true
}

Common error response

Typical error response

{
    "ok": false,
    "error": "invalid_auth"
}

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.

Error	Description
`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.
`user_not_found`	Error fetching user
`failed_for_some_users`	Some user ids failed to have their session invalidated. Details in extended comments
`cannot_reset_bot`	Cannot reset bot users
`session_reset_not_allowed`	Only primary owner can reset primary owner's sessions
`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.
`access_denied`	Access to a resource specified in the request is denied.
`account_inactive`	Authentication token is for a deleted user or workspace when using a `bot` token.
`token_revoked`	Authentication token is for a deleted user or workspace or the app has been removed when using a `user` token.
`token_expired`	Authentication token has expired
`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.
`method_deprecated`	The method has been deprecated.
`deprecated_endpoint`	The endpoint has been deprecated.
`two_factor_setup_required`	Two factor setup is required.
`enterprise_is_restricted`	The method cannot be called from an Enterprise.
`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_array_arg`	The method was passed an array as an argument. Please only input valid strings.
`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.
`accesslimited`	Access to this method is limited on the current network
`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.

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.

Warning	Description
`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.

API response

URL

POST body

Submit your arguments to see the API response

Was this page helpful?