PUT /cloudconnectoruser/{uuid}

PUT /cloudconnectoruser/{uuid}

/cloudconnectoruser/{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 of type(s) application/json
Optional 
{
    "_last_modified": "string",
    "azure_serviceprincipal": {
        "application_id": "string",
        "authentication_token": "string",
        "tenant_id": "string"
    },
    "azure_userpass": {
        "password": "string",
        "tenant_name": "string",
        "username": "string"
    },
    "configpb_attributes": {
        "version": 0
    },
    "gcp_credentials": {
        "service_account_keyfile_data": "string"
    },
    "name": "string",
    "nsxt_credentials": {
        "password": "string",
        "username": "string"
    },
    "oci_credentials": {
        "fingerprint": "string",
        "key_content": "string",
        "pass_phrase": "string",
        "user": "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
Optional

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

AzureServicePrincipalCredentials
azure_serviceprincipal
Optional

azure_serviceprincipal

AzureUserPassCredentials
azure_userpass
Optional

azure_userpass

ConfigPbAttributes
configpb_attributes
Optional

configpb_attributes

GCPCredentials
gcp_credentials
Optional

gcp_credentials

string
name
Required

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

NsxtCredentials
nsxt_credentials
Optional

nsxt_credentials

OCICredentials
oci_credentials
Optional

oci_credentials

string
password
Optional

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

string
private_key
Optional

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

string
public_key
Optional

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

string
tenant_ref
Optional

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

TencentCredentials
tencent_credentials
Optional

tencent_credentials

string
url
Optional

url

string
uuid
Optional

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

VCenterCredentials
vcenter_credentials
Optional

vcenter_credentials

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"
    },
    "configpb_attributes": {
        "version": 0
    },
    "gcp_credentials": {
        "service_account_keyfile_data": "string"
    },
    "name": "string",
    "nsxt_credentials": {
        "password": "string",
        "username": "string"
    },
    "oci_credentials": {
        "fingerprint": "string",
        "key_content": "string",
        "pass_phrase": "string",
        "user": "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
Optional

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

AzureServicePrincipalCredentials
azure_serviceprincipal
Optional

azure_serviceprincipal

AzureUserPassCredentials
azure_userpass
Optional

azure_userpass

ConfigPbAttributes
configpb_attributes
Optional

configpb_attributes

GCPCredentials
gcp_credentials
Optional

gcp_credentials

string
name
Required

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

NsxtCredentials
nsxt_credentials
Optional

nsxt_credentials

OCICredentials
oci_credentials
Optional

oci_credentials

string
password
Optional

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

string
private_key
Optional

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

string
public_key
Optional

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

string
tenant_ref
Optional

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

TencentCredentials
tencent_credentials
Optional

tencent_credentials

string
url
Optional

url

string
uuid
Optional

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

VCenterCredentials
vcenter_credentials
Optional

vcenter_credentials


401

log in failed

Operation doesn't return any data structure

On This Page
Cloud Connector User Operations
DELETE
DELETE /cloudconnectoruser/{uuid}
GET
GET /cloudconnectoruser
GET
GET /cloudconnectoruser/{uuid}
PATCH
PATCH /cloudconnectoruser/{uuid}
POST
POST /cloudconnectoruser
POST
POST /cloudconnectoruser/{uuid}/test
PUT
PUT /cloudconnectoruser/{uuid}