Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

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

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

{
"args": {
"desktop_app_browser_quit": {
"desc": "Terminate the session when the client—either the desktop app or a browser window—is closed.",
"example": "true",
"required": false,
"type": "boolean"
},
"duration": {
"desc": "The session duration, in seconds. The minimum value is 28800, which represents 8 hours; the max value is 315569520 or 10 years (that's a long Slack session).",
"example": "86400",
"required": false,
"type": "integer"
},
"user_ids": {
"desc": "The list of up to 1,000 user IDs to apply the session settings for",
"example": "['U12345','U67890']",
"required": true,
"type": "array"
}
},
"desc": "Configure the user-level session settings—the session duration and what happens when the client closes—for one or more users.",
"errors": {
"admin_unauthorized": "The token provided doesn't have permission to revoke a session.",
"at_least_one_session_setting_required": "At least one session setting is required.",
"bots_not_allowed": "Bot sessions are not listed by this method.",
"feature_not_enabled": "This method is only available for Enterprise organizations.",
"not_an_admin": "This method is only accessible by Org Owners and Admins",
"unable_to_update_existing_sessions": "The session settings could not be applied to users' existing sessions.",
"unknown_method": "This method is currently not available.",
"user_not_found": "At least one of the requested users doesn't exist."
},
"rate_limit": {
"label": "Tier 4: 100+ 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"
}
]
}
}