PUT /useraccountprofile/{uuid}

PUT /useraccountprofile/{uuid}

/useraccountprofile/{uuid}

Request
URI
PUT
https://{api_host}/api/useraccountprofile/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

Request Body

UserAccountProfile object creation

UserAccountProfile of type(s) application/json
Optional

Show optional properties

{
    "name": "string"
}
{
    "_last_modified": "string",
    "account_lock_timeout": 0,
    "configpb_attributes": {
        "version": 0
    },
    "credentials_timeout_threshold": 0,
    "login_failure_count_expiry_window": 0,
    "max_concurrent_sessions": 0,
    "max_login_failure_count": 0,
    "max_password_history_count": 0,
    "name": "string",
    "url": "string",
    "uuid": "string"
}
Responses
200

OK

Returns UserAccountProfile of type(s) application/json 
"UserAccountProfile Object"
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

integer As uint32 As uint32
account_lock_timeout
Optional
Constraints: default: 30

Lock timeout period (in minutes). Default is 30 minutes. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
configpb_attributes
Optional

configpb_attributes

integer As uint32 As uint32
credentials_timeout_threshold
Optional
Constraints: default: 180

The time period after which credentials expire. Default is 180 days. Unit is DAYS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
login_failure_count_expiry_window
Optional

The configurable time window beyond which we need to pop all the login failure timestamps from the login_failure_timestamps. Special values are 0 - Do not reset login_failure_counts on the basis of time.. Field introduced in 22.1.1. Unit is MIN. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
max_concurrent_sessions
Optional

Maximum number of concurrent sessions allowed. There are unlimited sessions by default. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
max_login_failure_count
Optional
Constraints: default: 3

Number of login attempts before lockout. Default is 3 attempts. Allowed values are 3-20. Special values are 0- Unlimited login attempts allowed.. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
max_password_history_count
Optional
Constraints: default: 4

Maximum number of passwords to be maintained in the password history. Default is 4 passwords. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Required

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string"}' https://{api_host}/api/useraccountprofile/{uuid}
On This Page
User Account Profile Operations
GET
GET /useraccountprofile
POST
POST /useraccountprofile
GET
GET /useraccountprofile/{uuid}
PUT
PUT /useraccountprofile/{uuid}
PATCH
PATCH /useraccountprofile/{uuid}
DELETE
DELETE /useraccountprofile/{uuid}