Current section
Files
Jump to
Current section
Files
priv/docs/methods/admin.users.setExpiration.json
{
"args": {
"expiration_ts": {
"desc": "Epoch timestamp in seconds when guest account should be disabled.",
"example": "1234567890",
"required": true,
"type": "integer"
},
"team_id": {
"desc": "The ID (`T1234`) of the workspace.",
"required": false
},
"user_id": {
"desc": "The ID of the user to set an expiration for.",
"example": "W12345678",
"required": true,
"type": "string"
}
},
"desc": "Set an expiration for a guest user",
"errors": {
"failed_looking_up_user": "We couldn't find the requested user.",
"failed_to_set_expiration": "The expiration could not be set for the user.",
"failed_to_validate_caller": "The token calling this method doesn't have permission to invite a user.",
"failed_to_validate_expiration": "`expiration_ts` was invalid.",
"failed_to_validate_team": "The team calling this method was invalid.",
"feature_not_enabled": "The Admin APIs feature is not enabled for this team.",
"team_id_required_for_enterprise": "Team ID required.",
"team_not_found": "`team_id` was not found.",
"user_is_already_deleted": "The user has already been deleted and disabled.",
"user_is_deactivated": "User has been deactivated.",
"user_is_not_a_guest": "The passed user\\_id does not belong to a guest user.",
"user_not_found": "The user could not be found."
},
"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"
}
]
}
}