PUT /cloudconnectoruser/{uuid}

PUT /cloudconnectoruser/{uuid}

/cloudconnectoruser/{uuid}/{uuid}

Request
URI
PUT
https://{api_host}/api/cloudconnectoruser/{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

CloudConnectorUser object creation

CloudConnectorUser of type(s) application/json
Optional

Show optional properties

{
    "name": "string"
}
{
    "_last_modified": "string",
    "azure_serviceprincipal": {
        "application_id": "string",
        "authentication_token": "string",
        "tenant_id": "string"
    },
    "azure_userpass": {
        "password": "string",
        "tenant_name": "string",
        "username": "string"
    },
    "gcp_credentials": {
        "service_account_keyfile_data": "string"
    },
    "last_password_rotation": 0,
    "name": "string",
    "new_password_enc": "string",
    "nsxt_credentials": {
        "password": "string",
        "username": "string"
    },
    "password": "string",
    "private_key": "string",
    "public_key": "string",
    "tenant_ref": "string",
    "tencent_credentials": {
        "secret_id": "string",
        "secret_key": "string"
    },
    "url": "string",
    "uuid": "string",
    "vcenter_credentials": {
        "password": "string",
        "username": "string"
    }
}
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns CloudConnectorUser of type(s) application/json 
{
    "_last_modified": "string",
    "azure_serviceprincipal": {
        "application_id": "string",
        "authentication_token": "string",
        "tenant_id": "string"
    },
    "azure_userpass": {
        "password": "string",
        "tenant_name": "string",
        "username": "string"
    },
    "gcp_credentials": {
        "service_account_keyfile_data": "string"
    },
    "last_password_rotation": 0,
    "name": "string",
    "new_password_enc": "string",
    "nsxt_credentials": {
        "password": "string",
        "username": "string"
    },
    "password": "string",
    "private_key": "string",
    "public_key": "string",
    "tenant_ref": "string",
    "tencent_credentials": {
        "secret_id": "string",
        "secret_key": "string"
    },
    "url": "string",
    "uuid": "string",
    "vcenter_credentials": {
        "password": "string",
        "username": "string"
    }
}
string
_last_modified
Read-Only  

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

object
azure_serviceprincipal
Optional

azure_serviceprincipal

object
azure_userpass
Optional

azure_userpass

object
gcp_credentials
Optional

gcp_credentials

integer As uint64 As uint64
last_password_rotation
Optional

Timestamp (Unix epoch in seconds) of last successful password rotation. Used to determine when next rotation is due based on cc_user_password_expiry_days. Field introduced in 32.1.1. Unit is SEC. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
name
Required  

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

string
new_password_enc
Optional

New password stored temporarily during rotation. Cleared after successful rotation. Field introduced in 32.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

object
nsxt_credentials
Optional

nsxt_credentials

string
password
Optional

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

string
private_key
Optional

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

string
public_key
Optional

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

string
tenant_ref
Optional

It is a reference to an object of type Tenant. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

object
tencent_credentials
Optional

tencent_credentials

string
url
Read-Only  

url

string
uuid
Optional

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

object
vcenter_credentials
Optional

vcenter_credentials


401

log in failed

Operation doesn't return any data structure

404

object not found

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/cloudconnectoruser/{uuid}
On This Page
Cloud Connector User Operations
GET
GET /cloudconnectoruser
POST
POST /cloudconnectoruser
GET
GET /cloudconnectoruser/{uuid}
PUT
PUT /cloudconnectoruser/{uuid}
PATCH
PATCH /cloudconnectoruser/{uuid}
DELETE
DELETE /cloudconnectoruser/{uuid}
POST
POST /cloudconnectoruser/{uuid}/test