Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

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

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

{
"args": {
"cursor": {
"desc": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.",
"example": "5c3e53d5",
"required": false,
"type": "string"
},
"limit": {
"default": "1000",
"desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.",
"example": "100",
"required": false,
"type": "integer"
},
"team_id": {
"desc": "The ID of the workspace you'd like active sessions for. If you pass a `team_id`, you'll need to pass a `user_id` as well. If no `user_id` and `team_id` are passed, you'll receive a paginated list of _all_ sessions. When you pass `user_id` and `team_id` (which must be used together), you'll receive a list of active sessions by that user on the workspace specified by `team_id`.",
"example": "T1234",
"required": false,
"type": "string"
},
"user_id": {
"desc": "The ID of user you'd like active sessions for. If you pass a `user_id`, you'll need to pass a `team_id` as well. If no `user_id` and `team_id` are passed, you'll receive a paginated list of _all_ sessions. When you pass `user_id` and `team_id` (which must be used together), you'll receive a list of active sessions by that user on the workspace specified by `team_id`.",
"example": "U1234",
"required": false,
"type": "string"
}
},
"desc": "List active user sessions for an organization",
"errors": {
"admin_unauthorized": "The owner of this token isn't authorized to list sessions.",
"bots_not_allowed": "Bot sessions are not listed by this method.",
"feature_not_enabled": "This method is only available to Enterprise customers.",
"invalid_cursor": "The cursor passed was invalid.",
"missing_team": "A `team_id` must be provided with a `user_id`.",
"missing_user": "A `user_id` must be provided with a `team_id`.",
"no_active_sessions": "No active sessions were found.",
"not_an_admin": "The owner of this token isn't an Org Owner or Admin.",
"team_not_found": "There was an error finding the requested workspace.",
"unknown_method": "This method is currently not available.",
"user_not_found": "There was an error finding the requested user."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"user": [
{
"name": "admin.users:read",
"url": "https://docs.slack.dev/reference/scopes/admin.users.read"
}
]
}
}