Avi User Object API

CLI ``` - configure user - show user ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 21.1.6
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /user
  2. post /user
  3. delete /user/{uuid}
  4. get /user/{uuid}
  5. patch /user/{uuid}
  6. put /user/{uuid}
Up 
get /user
(userGet)

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

UserApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "access" : [ {
      "all_tenants" : true,
      "object_access_policy_ref" : "aeiou",
      "tenant_ref" : "aeiou",
      "role_ref" : "aeiou"
    } ],
    "is_superuser" : true,
    "uuid" : "aeiou",
    "local" : true,
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "default_tenant_ref" : "aeiou",
    "password" : "aeiou",
    "full_name" : "aeiou",
    "user_profile_ref" : "aeiou",
    "name" : "aeiou",
    "email" : "aeiou",
    "username" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK UserApiResponse

401

log in failed
Up 
post /user
(userPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — User object creation

Return type

User

Example data

Content-Type: application/json
{
  "access" : [ {
    "all_tenants" : true,
    "object_access_policy_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "role_ref" : "aeiou"
  } ],
  "is_superuser" : true,
  "uuid" : "aeiou",
  "local" : true,
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "default_tenant_ref" : "aeiou",
  "password" : "aeiou",
  "full_name" : "aeiou",
  "user_profile_ref" : "aeiou",
  "name" : "aeiou",
  "email" : "aeiou",
  "username" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK User

401

log in failed
Up 
delete /user/{uuid}
(userUuidDelete)

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found
Up 
get /user/{uuid}
(userUuidGet)

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

User

Example data

Content-Type: application/json
{
  "access" : [ {
    "all_tenants" : true,
    "object_access_policy_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "role_ref" : "aeiou"
  } ],
  "is_superuser" : true,
  "uuid" : "aeiou",
  "local" : true,
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "default_tenant_ref" : "aeiou",
  "password" : "aeiou",
  "full_name" : "aeiou",
  "user_profile_ref" : "aeiou",
  "name" : "aeiou",
  "email" : "aeiou",
  "username" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK User

401

log in failed
Up 
patch /user/{uuid}
(userUuidPatch)

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 — User object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

User

Example data

Content-Type: application/json
{
  "access" : [ {
    "all_tenants" : true,
    "object_access_policy_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "role_ref" : "aeiou"
  } ],
  "is_superuser" : true,
  "uuid" : "aeiou",
  "local" : true,
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "default_tenant_ref" : "aeiou",
  "password" : "aeiou",
  "full_name" : "aeiou",
  "user_profile_ref" : "aeiou",
  "name" : "aeiou",
  "email" : "aeiou",
  "username" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK User

401

log in failed
Up 
put /user/{uuid}
(userUuidPut)

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 — User object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

User

Example data

Content-Type: application/json
{
  "access" : [ {
    "all_tenants" : true,
    "object_access_policy_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "role_ref" : "aeiou"
  } ],
  "is_superuser" : true,
  "uuid" : "aeiou",
  "local" : true,
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "default_tenant_ref" : "aeiou",
  "password" : "aeiou",
  "full_name" : "aeiou",
  "user_profile_ref" : "aeiou",
  "name" : "aeiou",
  "email" : "aeiou",
  "username" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK User

401

log in failed
Up

Models

[ Jump to Methods ]

Table of Contents

  1. User
  2. UserApiResponse
  3. UserRole

User Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
access (optional)
array[UserRole] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
default_tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
email (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
full_name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
is_superuser (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
local (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
password (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
String url
user_profile_ref (optional)
String It is a reference to an object of type UserAccountProfile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
username (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

UserApiResponse Up

count
Integer format: int32
results
array[User]
next (optional)
String

UserRole Up

all_tenants (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
object_access_policy_ref (optional)
String Reference to the Object Access Policy that defines a User's access in the corresponding Tenant. It is a reference to an object of type ObjectAccessPolicy. Field deprecated in 20.1.2. Field introduced in 18.2.7, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
role_ref (optional)
String It is a reference to an object of type Role. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.