Avi UserAccountProfile Object API
CLI ``` - configure useraccountprofile - show useraccountprofile ```
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 /useraccountprofilepost /useraccountprofiledelete /useraccountprofile/{uuid}get /useraccountprofile/{uuid}patch /useraccountprofile/{uuid}put /useraccountprofile/{uuid}
Up
get /useraccountprofile
(useraccountprofileGet)
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" : [ {
"max_password_history_count" : 123,
"credentials_timeout_threshold" : 123,
"max_concurrent_sessions" : 123,
"name" : "aeiou",
"max_login_failure_count" : 123,
"account_lock_timeout" : 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
UserAccountProfileApiResponse
401
log in failed
Up
post /useraccountprofile
(useraccountprofilePost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — UserAccountProfile object creation
Return type
Example data
Content-Type: application/json
{
"max_password_history_count" : 123,
"credentials_timeout_threshold" : 123,
"max_concurrent_sessions" : 123,
"name" : "aeiou",
"max_login_failure_count" : 123,
"account_lock_timeout" : 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
UserAccountProfile
401
log in failed
Up
delete /useraccountprofile/{uuid}
(useraccountprofileUuidDelete)
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 /useraccountprofile/{uuid}
(useraccountprofileUuidGet)
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
{
"max_password_history_count" : 123,
"credentials_timeout_threshold" : 123,
"max_concurrent_sessions" : 123,
"name" : "aeiou",
"max_login_failure_count" : 123,
"account_lock_timeout" : 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
UserAccountProfile
401
log in failed
Up
patch /useraccountprofile/{uuid}
(useraccountprofileUuidPatch)
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 — UserAccountProfile object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"max_password_history_count" : 123,
"credentials_timeout_threshold" : 123,
"max_concurrent_sessions" : 123,
"name" : "aeiou",
"max_login_failure_count" : 123,
"account_lock_timeout" : 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
UserAccountProfile
401
log in failed
Up
put /useraccountprofile/{uuid}
(useraccountprofileUuidPut)
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 — UserAccountProfile object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"max_password_history_count" : 123,
"credentials_timeout_threshold" : 123,
"max_concurrent_sessions" : 123,
"name" : "aeiou",
"max_login_failure_count" : 123,
"account_lock_timeout" : 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
UserAccountProfile
401
log in failed
[ Jump to Methods ]
Table of Contents
UserAccountProfileUserAccountProfileApiResponse
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
account_lock_timeout (optional)
Integer Lock timeout period (in minutes). Default is 30 minutes. Unit is MIN. format: int32
credentials_timeout_threshold (optional)
Integer The time period after which credentials expire. Default is 180 days. Unit is DAYS. format: int32
max_concurrent_sessions (optional)
Integer Maximum number of concurrent sessions allowed. There are unlimited sessions by default. format: int32
max_login_failure_count (optional)
Integer Number of login attempts before lockout. Default is 3 attempts. Allowed values are 3-20. Special values are 0 - 'Unlimited login attempts allowed.'. format: int32
max_password_history_count (optional)
Integer Maximum number of passwords to be maintained in the password history. Default is 4 passwords. format: int32
name
url (optional)
uuid (optional)
String Unique object identifier of the object.
count
results
next (optional)