Suspend a team user

This function immediately suspends a team user.

SecurityBasicAuth

Request

query Parameters

user required	string The username of the team user. Example: user=teamuser
reason	string The reason for suspension. Example: reason=teamuser is on vacation

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/Team/suspend_team_user

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Team \
  suspend_team_user \
  user='teamuser'

Response samples

application/json

{"apiversion": 3,
"func": "suspend_team_user",
"module": "Team",
"result": {"data": { },
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}