Avi AuthMappingProfile Object API
CLI ``` - configure authmappingprofile - show authmappingprofile ```
Version: 22.1.6
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /authmappingprofilepost /authmappingprofiledelete /authmappingprofile/{uuid}get /authmappingprofile/{uuid}patch /authmappingprofile/{uuid}put /authmappingprofile/{uuid}
Up
get /authmappingprofile
(authmappingprofileGet)
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" : [ {
"mapping_rules" : [ {
"role_attribute_name" : "aeiou",
"userprofile_ref" : "aeiou",
"assign_role" : "aeiou",
"is_superuser" : true,
"assign_tenant" : "aeiou",
"assign_userprofile" : "aeiou",
"index" : 123,
"policy_attribute_name" : "aeiou",
"role_refs" : [ "aeiou" ],
"default_tenant_ref" : "aeiou",
"tenant_refs" : [ "aeiou" ],
"assign_policy" : "aeiou",
"attribute_match" : {
"criteria" : "aeiou",
"values" : [ "aeiou" ],
"name" : "aeiou"
},
"group_match" : {
"criteria" : "aeiou",
"groups" : [ "aeiou" ]
},
"userprofile_attribute_name" : "aeiou",
"tenant_attribute_name" : "aeiou"
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"description" : "aeiou",
"type" : "aeiou",
"uuid" : "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
AuthMappingProfileApiResponse
401
log in failed
Up
post /authmappingprofile
(authmappingprofilePost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — AuthMappingProfile object creation
Return type
Example data
Content-Type: application/json
{
"mapping_rules" : [ {
"role_attribute_name" : "aeiou",
"userprofile_ref" : "aeiou",
"assign_role" : "aeiou",
"is_superuser" : true,
"assign_tenant" : "aeiou",
"assign_userprofile" : "aeiou",
"index" : 123,
"policy_attribute_name" : "aeiou",
"role_refs" : [ "aeiou" ],
"default_tenant_ref" : "aeiou",
"tenant_refs" : [ "aeiou" ],
"assign_policy" : "aeiou",
"attribute_match" : {
"criteria" : "aeiou",
"values" : [ "aeiou" ],
"name" : "aeiou"
},
"group_match" : {
"criteria" : "aeiou",
"groups" : [ "aeiou" ]
},
"userprofile_attribute_name" : "aeiou",
"tenant_attribute_name" : "aeiou"
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"description" : "aeiou",
"type" : "aeiou",
"uuid" : "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
AuthMappingProfile
401
log in failed
Up
delete /authmappingprofile/{uuid}
(authmappingprofileUuidDelete)
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 /authmappingprofile/{uuid}
(authmappingprofileUuidGet)
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
{
"mapping_rules" : [ {
"role_attribute_name" : "aeiou",
"userprofile_ref" : "aeiou",
"assign_role" : "aeiou",
"is_superuser" : true,
"assign_tenant" : "aeiou",
"assign_userprofile" : "aeiou",
"index" : 123,
"policy_attribute_name" : "aeiou",
"role_refs" : [ "aeiou" ],
"default_tenant_ref" : "aeiou",
"tenant_refs" : [ "aeiou" ],
"assign_policy" : "aeiou",
"attribute_match" : {
"criteria" : "aeiou",
"values" : [ "aeiou" ],
"name" : "aeiou"
},
"group_match" : {
"criteria" : "aeiou",
"groups" : [ "aeiou" ]
},
"userprofile_attribute_name" : "aeiou",
"tenant_attribute_name" : "aeiou"
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"description" : "aeiou",
"type" : "aeiou",
"uuid" : "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
AuthMappingProfile
401
log in failed
Up
patch /authmappingprofile/{uuid}
(authmappingprofileUuidPatch)
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 — AuthMappingProfile object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"mapping_rules" : [ {
"role_attribute_name" : "aeiou",
"userprofile_ref" : "aeiou",
"assign_role" : "aeiou",
"is_superuser" : true,
"assign_tenant" : "aeiou",
"assign_userprofile" : "aeiou",
"index" : 123,
"policy_attribute_name" : "aeiou",
"role_refs" : [ "aeiou" ],
"default_tenant_ref" : "aeiou",
"tenant_refs" : [ "aeiou" ],
"assign_policy" : "aeiou",
"attribute_match" : {
"criteria" : "aeiou",
"values" : [ "aeiou" ],
"name" : "aeiou"
},
"group_match" : {
"criteria" : "aeiou",
"groups" : [ "aeiou" ]
},
"userprofile_attribute_name" : "aeiou",
"tenant_attribute_name" : "aeiou"
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"description" : "aeiou",
"type" : "aeiou",
"uuid" : "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
AuthMappingProfile
401
log in failed
Up
put /authmappingprofile/{uuid}
(authmappingprofileUuidPut)
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 — AuthMappingProfile object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"mapping_rules" : [ {
"role_attribute_name" : "aeiou",
"userprofile_ref" : "aeiou",
"assign_role" : "aeiou",
"is_superuser" : true,
"assign_tenant" : "aeiou",
"assign_userprofile" : "aeiou",
"index" : 123,
"policy_attribute_name" : "aeiou",
"role_refs" : [ "aeiou" ],
"default_tenant_ref" : "aeiou",
"tenant_refs" : [ "aeiou" ],
"assign_policy" : "aeiou",
"attribute_match" : {
"criteria" : "aeiou",
"values" : [ "aeiou" ],
"name" : "aeiou"
},
"group_match" : {
"criteria" : "aeiou",
"groups" : [ "aeiou" ]
},
"userprofile_attribute_name" : "aeiou",
"tenant_attribute_name" : "aeiou"
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"description" : "aeiou",
"type" : "aeiou",
"uuid" : "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
AuthMappingProfile
401
log in failed
[ Jump to Methods ]
Table of Contents
AuthMappingProfileAuthMappingProfileApiResponseAuthMappingRuleAuthMatchAttributeAuthMatchGroupMembershipConfigPbAttributes
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
configpb_attributes (optional)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
description (optional)
String Description for the AuthMappingProfile. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
mapping_rules (optional)
array[AuthMappingRule] Rules list for tenant or role mapping. Field introduced in 22.1.1. Minimum of 1 items required. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
name
String Name of the AuthMappingProfile. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
tenant_ref (optional)
String Tenant ref for the auth mapping profile. It is a reference to an object of type Tenant. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
type
String Type of the Auth Profile for which these rules can be linked. Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML, AUTH_PROFILE_PINGACCESS, AUTH_PROFILE_JWT, AUTH_PROFILE_OAUTH. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String UUID of the AuthMappingProfile. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
count
results
next (optional)
assign_policy (optional)
String Assignment rule for the Object Access Policy. Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX, ASSIGN_MATCHING_ATTRIBUTE_REGEX. Field introduced in 18.2.7, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
assign_role (optional)
String Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX, ASSIGN_MATCHING_ATTRIBUTE_REGEX. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
assign_tenant (optional)
String Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX, ASSIGN_MATCHING_ATTRIBUTE_REGEX. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
assign_userprofile (optional)
String Assignment rule for the User Account Profile. Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX, ASSIGN_MATCHING_ATTRIBUTE_REGEX. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
attribute_match (optional)
AuthMatchAttribute Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
default_tenant_ref (optional)
String Default tenant ref to assign to user. It is a reference to an object of type Tenant. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
group_match (optional)
AuthMatchGroupMembership Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
index
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
is_superuser (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
policy_attribute_name (optional)
String Attribute name for Object Access Policy assignment. Field introduced in 18.2.7, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
role_attribute_name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
role_refs (optional)
array[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_attribute_name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_refs (optional)
array[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.
userprofile_attribute_name (optional)
String Attribute name for User Account Profile assignment. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
userprofile_ref (optional)
String User Account Profile to assign to user on successful match. It is a reference to an object of type UserAccountProfile. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
criteria
String rule match criteria. Enum options - AUTH_MATCH_CONTAINS, AUTH_MATCH_DOES_NOT_CONTAIN, AUTH_MATCH_REGEX. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
values (optional)
array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
criteria
String rule match criteria. Enum options - AUTH_MATCH_CONTAINS, AUTH_MATCH_DOES_NOT_CONTAIN, AUTH_MATCH_REGEX. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
groups (optional)
array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32