Packages

A Slack Web & Real Time Messaging API client.

Retired package: Renamed - 1.0.0-alpha.0

Current section

Files

Jump to
slack_kit lib slack web docs admin.users.session.setSettings.json
Raw

lib/slack/web/docs/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": {
"access_denied": "Access to a resource specified in the request is denied.",
"accesslimited": "Access to this method is limited on the current network",
"account_inactive": "Authentication token is for a deleted user or workspace when using a `bot` token.",
"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.",
"deprecated_endpoint": "The endpoint has been deprecated.",
"ekm_access_denied": "Administrators have suspended the ability to post a message.",
"enterprise_is_restricted": "The method cannot be called from an Enterprise.",
"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.",
"feature_not_enabled": "This method is only available for Enterprise organizations.",
"internal_error": "There was an internal error processing this request—please retry.",
"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_arguments": "Required arguments either were not provided or contain invalid values.",
"invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.",
"invalid_auth": "The token doesn't have access to this endpoint.",
"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`.",
"method_deprecated": "The method has been deprecated.",
"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.",
"missing_scope": "The token used is not granted the specific scope permissions required to complete this request.",
"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.",
"not_allowed_token_type": "The token type used in this request is not allowed.",
"not_an_admin": "This method is only accessible by Org Owners and Admins",
"not_authed": "No authentication token provided.",
"org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.",
"ratelimited": "The rate limit for this endpoint has been reached.",
"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",
"team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.",
"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.",
"token_expired": "Authentication token has expired",
"token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a `user` token.",
"two_factor_setup_required": "Two factor setup is required.",
"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."
}
}