Avi UserActivity Object API
CLI ``` - show useractivity ```
Contact Info: support@avinetworks.com
Version: 20.1.9
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /useractivitypost /useractivitydelete /useractivity/{uuid}get /useractivity/{uuid}patch /useractivity/{uuid}put /useractivity/{uuid}
(useractivityGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"last_login_timestamp" : "aeiou",
"concurrent_sessions" : 123,
"last_login_ip" : "aeiou",
"logged_in" : true,
"name" : "aeiou",
"last_password_update" : "aeiou",
"previous_password" : [ "aeiou" ],
"failed_login_attempts" : 123,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
UserActivityApiResponse
401
log in failed
(useractivityPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — UserActivity object creation
Return type
Example data
Content-Type: application/json
{
"last_login_timestamp" : "aeiou",
"concurrent_sessions" : 123,
"last_login_ip" : "aeiou",
"logged_in" : true,
"name" : "aeiou",
"last_password_update" : "aeiou",
"previous_password" : [ "aeiou" ],
"failed_login_attempts" : 123,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
UserActivity
401
log in failed
Up
delete /useractivity/{uuid}
(useractivityUuidDelete)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
object deleted
String
404
not found
Up
get /useractivity/{uuid}
(useractivityUuidGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"last_login_timestamp" : "aeiou",
"concurrent_sessions" : 123,
"last_login_ip" : "aeiou",
"logged_in" : true,
"name" : "aeiou",
"last_password_update" : "aeiou",
"previous_password" : [ "aeiou" ],
"failed_login_attempts" : 123,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
UserActivity
401
log in failed
Up
patch /useractivity/{uuid}
(useractivityUuidPatch)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — UserActivity object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"last_login_timestamp" : "aeiou",
"concurrent_sessions" : 123,
"last_login_ip" : "aeiou",
"logged_in" : true,
"name" : "aeiou",
"last_password_update" : "aeiou",
"previous_password" : [ "aeiou" ],
"failed_login_attempts" : 123,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
UserActivity
401
log in failed
Up
put /useractivity/{uuid}
(useractivityUuidPut)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — UserActivity object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"last_login_timestamp" : "aeiou",
"concurrent_sessions" : 123,
"last_login_ip" : "aeiou",
"logged_in" : true,
"name" : "aeiou",
"last_password_update" : "aeiou",
"previous_password" : [ "aeiou" ],
"failed_login_attempts" : 123,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
UserActivity
401
log in failed
[ Jump to Methods ]
Table of Contents
UserActivityUserActivityApiResponse
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
concurrent_sessions (optional)
Integer Number of concurrent user sessions open. format: int32
failed_login_attempts (optional)
Integer Number of failed login attempts before a successful login. format: int32
last_login_ip (optional)
String IP of the machine the user was last logged in from.
last_login_timestamp (optional)
String Timestamp of last login.
last_password_update (optional)
String Timestamp of last password update.
logged_in (optional)
Boolean Indicates whether the user is logged in or not.
name (optional)
String Name of the user this object refers to.
previous_password (optional)
array[String] Stores the previous n passwords where n is ControllerProperties.max_password_history_count. .
url (optional)
uuid (optional)
String Unique object identifier of the object.
count
results
next (optional)