PATCH /jwtserverprofile/{uuid}

PATCH /jwtserverprofile/{uuid}

/jwtserverprofile/{uuid}

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

JWTServerProfile object creation

JWTServerProfile of type(s) application/json
Optional

Show optional properties

{
    "name": "string"
}
{
    "_last_modified": "string",
    "configpb_attributes": {
        "version": 0
    },
    "controller_internal_auth": {
        "symmetric_jwks_keys": [
            {
                "alg": "string",
                "key": "string",
                "kid": "string",
                "kty": "string"
            }
        ]
    },
    "is_federated": false,
    "issuer": "string",
    "jwks_keys": "string",
    "jwt_profile_type": "string",
    "name": "string",
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
Responses
200

OK

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

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

object
configpb_attributes
Optional

configpb_attributes

object
controller_internal_auth
Optional

controller_internal_auth

boolean
is_federated
Optional

This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster. If the field is set to true, then the object is replicated across the federation. . Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
issuer
Optional

Uniquely identifiable name of the Token Issuer, only allowed with profile_type CLIENT_AUTH. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
jwks_keys
Optional

JWKS key set used for validating the JWT, only allowed with profile_type CLIENT_AUTH. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
jwt_profile_type
Optional
Constraints: default: CLIENT_AUTH

Type of JWT Server profile which defines the usage type. Enum options - CLIENT_AUTH, CONTROLLER_INTERNAL_AUTH. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
name
Required

Name of the JWT Profile. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

UUID of the Tenant. It is a reference to an object of type Tenant. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

UUID of the JWTProfile. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string"}'
On This Page
Jwtserver Profile Operations
GET
GET /jwtserverprofile
POST
POST /jwtserverprofile
GET
GET /jwtserverprofile/{uuid}
PUT
PUT /jwtserverprofile/{uuid}
PATCH
PATCH /jwtserverprofile/{uuid}
DELETE
DELETE /jwtserverprofile/{uuid}
GET
GET /jwtserverprofile/{uuid}/federated_info/