Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods admin.users.session.resetBulk.json
Raw

priv/docs/methods/admin.users.session.resetBulk.json

{
"args": {
"mobile_only": {
"desc": "Only expire mobile sessions (default: false). Use the `web_only` and `mobile_only` parameters to wipe only web or only mobile sessions.",
"required": false,
"type": "boolean"
},
"user_ids": {
"desc": "The list of up to 1,000 user IDs to wipe sessions for",
"example": "[\"W12345678\", \"W98765432\"]",
"required": true,
"type": "array"
},
"web_only": {
"desc": "Only expire web sessions (default: false). Use the `web_only` and `mobile_only` parameters to wipe only web or only mobile sessions.",
"required": false,
"type": "boolean"
}
},
"desc": "Enqueues an asynchronous job to wipe all valid sessions on all devices for a given list of users",
"errors": {
"cannot_reset_bot": "Cannot reset bot users",
"cannot_reset_primary_owner": "Only primary owner can reset primary owner's sessions",
"failed_for_some_users": "Some user ids failed to have their session invalidated. Details in extended comments",
"feature_not_enabled": "This method is not available for this product level",
"not_an_admin": "This method is only accessible by org/compliance team owners and admins",
"restricted_action": "Restricted action.",
"session_reset_not_allowed": "Only primary owner can reset primary owner's sessions",
"unknown_method": "This method is currently not available",
"user_not_found": "Error fetching user",
"user_session_reset_failed": "There was an error starting the session reset. Try again."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"user": [
{
"name": "admin.users:write",
"url": "https://docs.slack.dev/reference/scopes/admin.users.write"
}
]
}
}