PUT /authmappingprofile/{uuid}

/authmappingprofile/{uuid}

Request

URI

PUT

https://api_host/api/authmappingprofile/{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

AuthMappingProfile of type(s) application/json

Optional

{
    "_last_modified": "string",
    "configpb_attributes": {
        "version": 0
    },
    "description": "string",
    "mapping_rules": [
        {
            "assign_policy": "string",
            "assign_role": "string",
            "assign_tenant": "string",
            "assign_userprofile": "string",
            "attribute_match": {
                "criteria": "string",
                "name": "string",
                "values": [
                    "string"
                ]
            },
            "default_tenant_ref": "string",
            "group_match": {
                "criteria": "string",
                "groups": [
                    "string"
                ]
            },
            "index": 0,
            "is_superuser": false,
            "policy_attribute_name": "string",
            "role_attribute_name": "string",
            "role_refs": [
                "string"
            ],
            "tenant_attribute_name": "string",
            "tenant_refs": [
                "string"
            ],
            "userprofile_attribute_name": "string",
            "userprofile_ref": "string"
        }
    ],
    "name": "string",
    "tenant_ref": "string",
    "type": "string",
    "url": "string",
    "uuid": "string"
}

string

_last_modified

Optional

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

ConfigPbAttributes

configpb_attributes

Optional

configpb_attributes

string

description

Optional

Description for the AuthMappingProfile. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of AuthMappingRule

mapping_rules

Optional

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.

string

name

Required

Name of the AuthMappingProfile. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

tenant_ref

Optional

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.

string

type

Required

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.

string

url

Optional

url

string

uuid

Optional

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

Responses

200

Returns AuthMappingProfile of type(s) application/json

{
    "_last_modified": "string",
    "configpb_attributes": {
        "version": 0
    },
    "description": "string",
    "mapping_rules": [
        {
            "assign_policy": "string",
            "assign_role": "string",
            "assign_tenant": "string",
            "assign_userprofile": "string",
            "attribute_match": {
                "criteria": "string",
                "name": "string",
                "values": [
                    "string"
                ]
            },
            "default_tenant_ref": "string",
            "group_match": {
                "criteria": "string",
                "groups": [
                    "string"
                ]
            },
            "index": 0,
            "is_superuser": false,
            "policy_attribute_name": "string",
            "role_attribute_name": "string",
            "role_refs": [
                "string"
            ],
            "tenant_attribute_name": "string",
            "tenant_refs": [
                "string"
            ],
            "userprofile_attribute_name": "string",
            "userprofile_ref": "string"
        }
    ],
    "name": "string",
    "tenant_ref": "string",
    "type": "string",
    "url": "string",
    "uuid": "string"
}

string

_last_modified

Optional

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

ConfigPbAttributes

configpb_attributes

Optional

configpb_attributes

string

description

Optional

Description for the AuthMappingProfile. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of AuthMappingRule

mapping_rules

Optional

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.

string

name

Required

Name of the AuthMappingProfile. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

tenant_ref

Optional

string

type

Required

string

url