Avi JWTServerProfile Object API
CLI ``` - configure jwtserverprofile - show jwtserverprofile ```
Contact Info: support@avinetworks.com
Version: 20.1.9
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /jwtserverprofilepost /jwtserverprofiledelete /jwtserverprofile/{uuid}get /jwtserverprofile/{uuid}/federated_info/get /jwtserverprofile/{uuid}patch /jwtserverprofile/{uuid}put /jwtserverprofile/{uuid}
(jwtserverprofileGet)
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
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"controller_internal_auth" : {
"symmetric_jwks_keys" : [ {
"kty" : "aeiou",
"kid" : "aeiou",
"alg" : "aeiou",
"key" : "aeiou"
} ]
},
"tenant_ref" : "aeiou",
"jwks_keys" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"is_federated" : true,
"issuer" : "aeiou",
"jwt_profile_type" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
JWTServerProfileApiResponse
401
log in failed
Up
post /jwtserverprofile
(jwtserverprofilePost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — JWTServerProfile object creation
Return type
Example data
Content-Type: application/json
{
"controller_internal_auth" : {
"symmetric_jwks_keys" : [ {
"kty" : "aeiou",
"kid" : "aeiou",
"alg" : "aeiou",
"key" : "aeiou"
} ]
},
"tenant_ref" : "aeiou",
"jwks_keys" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"is_federated" : true,
"issuer" : "aeiou",
"jwt_profile_type" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
JWTServerProfile
401
log in failed
Up
delete /jwtserverprofile/{uuid}
(jwtserverprofileUuidDelete)
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
object deleted
String
404
not found
Up
get /jwtserverprofile/{uuid}/federated_info/
(jwtserverprofileUuidFederatedInfoGet)
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:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
Up
get /jwtserverprofile/{uuid}
(jwtserverprofileUuidGet)
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
Example data
Content-Type: application/json
{
"controller_internal_auth" : {
"symmetric_jwks_keys" : [ {
"kty" : "aeiou",
"kid" : "aeiou",
"alg" : "aeiou",
"key" : "aeiou"
} ]
},
"tenant_ref" : "aeiou",
"jwks_keys" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"is_federated" : true,
"issuer" : "aeiou",
"jwt_profile_type" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
JWTServerProfile
401
log in failed
Up
patch /jwtserverprofile/{uuid}
(jwtserverprofileUuidPatch)
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 — JWTServerProfile object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"controller_internal_auth" : {
"symmetric_jwks_keys" : [ {
"kty" : "aeiou",
"kid" : "aeiou",
"alg" : "aeiou",
"key" : "aeiou"
} ]
},
"tenant_ref" : "aeiou",
"jwks_keys" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"is_federated" : true,
"issuer" : "aeiou",
"jwt_profile_type" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
JWTServerProfile
401
log in failed
Up
put /jwtserverprofile/{uuid}
(jwtserverprofileUuidPut)
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 — JWTServerProfile object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"controller_internal_auth" : {
"symmetric_jwks_keys" : [ {
"kty" : "aeiou",
"kid" : "aeiou",
"alg" : "aeiou",
"key" : "aeiou"
} ]
},
"tenant_ref" : "aeiou",
"jwks_keys" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"is_federated" : true,
"issuer" : "aeiou",
"jwt_profile_type" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
JWTServerProfile
401
log in failed
[ Jump to Methods ]
Table of Contents
ControllerInternalAuthJWSKeyJWTServerProfileJWTServerProfileApiResponse
symmetric_jwks_keys (optional)
array[JWSKey] Symmetric keys used for signing/validating the JWT, only allowed with profile_type CONTROLLER_INTERNAL_AUTH. Field introduced in 20.1.6. Minimum of 1 items required. Maximum of 1 items allowed.
alg (optional)
String Algorithm that need to be used while signing/validation, allowed values HS256, HS384, HS512. Field introduced in 20.1.6.
key
String Secret JWK for signing/validation, length of the key varies depending upon the type of algorithm used for key generation {HS256 32 bytes, HS384 48bytes, HS512 64 bytes}. Field introduced in 20.1.6.
kid
String Unique key id across all keys. Field introduced in 20.1.6.
kty (optional)
String Secret key type/format, allowed value octet(oct). Field introduced in 20.1.6.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
controller_internal_auth (optional)
ControllerInternalAuth JWT Auth configuration for profile_type CONTROLLER_INTERNAL_AUTH. Field introduced in 20.1.6.
is_federated (optional)
Boolean 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.
issuer (optional)
String Uniquely identifiable name of the Token Issuer, only allowed with profile_type CLIENT_AUTH. Field introduced in 20.1.3.
jwks_keys (optional)
String JWKS key set used for validating the JWT, only allowed with profile_type CLIENT_AUTH. Field introduced in 20.1.3.
jwt_profile_type (optional)
String Type of JWT Server profile which defines the usage type. Enum options - CLIENT_AUTH, CONTROLLER_INTERNAL_AUTH. Field introduced in 20.1.6.
name
String Name of the JWT Profile. Field introduced in 20.1.3.
tenant_ref (optional)
String UUID of the Tenant. It is a reference to an object of type Tenant. Field introduced in 20.1.3.
url (optional)
uuid (optional)
String UUID of the JWTProfile. Field introduced in 20.1.3.
count
results
next (optional)