PUT /authprofile/{uuid}
/authprofile/{uuid}
UUID of the object to fetch
object name
Avi Tenant Header
Avi Tenant Header UUID
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.
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.
AuthProfile object creation
Show optional properties
{
"name": "string",
"type": "string"
}{
"_last_modified": "string",
"configpb_attributes": {
"version": 0
},
"description": "string",
"http": {
"cache_expiration_time": 0,
"request_header": "string",
"require_user_groups": [
"string"
]
},
"jwt_profile_ref": "string",
"ldap": {
"base_dn": "string",
"bind_as_administrator": false,
"email_attribute": "string",
"full_name_attribute": "string",
"port": 0,
"security_mode": "string",
"server": [
"string"
],
"settings": {
"admin_bind_dn": "string",
"group_filter": "string",
"group_member_attribute": "string",
"group_member_is_full_dn": false,
"group_search_dn": "string",
"group_search_scope": "string",
"ignore_referrals": false,
"password": "string",
"user_attributes": [
"string"
],
"user_id_attribute": "string",
"user_search_dn": "string",
"user_search_scope": "string"
},
"user_bind": {
"dn_template": "string",
"token": "string",
"user_attributes": [
"string"
],
"user_id_attribute": "string"
}
},
"markers": [
{
"key": "string",
"values": [
"string"
]
}
],
"name": "string",
"oauth_profile": {
"authorization_endpoint": "string",
"end_session_endpoint": "string",
"instance_id": "string",
"introspection_endpoint": "string",
"issuer": "string",
"jwks_timeout": 0,
"jwks_uri": "string",
"oauth_controller_settings": {
"client_id": "string",
"client_secret": "string",
"oidc_config": {
"oidc_enable": false,
"profile": false,
"userinfo": false
},
"scopes": [
"string"
]
},
"oauth_profile_type": "string",
"oauth_provider": "string",
"oauth_resp_buffer_sz": 0,
"org_id": "string",
"pool_ref": "string",
"redirect_uri": "string",
"service_id": "string",
"service_name": "string",
"token_endpoint": "string",
"userinfo_endpoint": "string"
},
"pa_agent_ref": "string",
"saml": {
"idp": {
"meta_data_download_interval": 0,
"metadata": "string",
"metadata_url": "string",
"periodic_download": false
},
"sp": {
"fqdn": "string",
"org_display_name": "string",
"org_name": "string",
"org_url": "string",
"saml_entity_type": "string",
"sp_nodes": [
{
"entity_id": "string",
"name": "string",
"signing_ssl_key_and_certificate_ref": "string",
"single_signon_url": "string"
}
],
"tech_contact_email": "string",
"tech_contact_name": "string"
}
},
"tacacs_plus": {
"authorization_attrs": [
{
"mandatory": false,
"name": "string",
"value": "string"
}
],
"password": "string",
"port": 0,
"server": [
"string"
],
"service": "string"
},
"tenant_ref": "string",
"type": "string",
"url": "string",
"uuid": "string"
}OK
"AuthProfile Object"UNIX time since epoch in microseconds. Units(MICROSECONDS).
configpb_attributes
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
http
JWTServerProfile to be used for authentication. It is a reference to an object of type JWTServerProfile. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ldap
List of labels to be used for granular RBAC. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
Name of the Auth Profile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
oauth_profile
PingAccessAgent uuid. It is a reference to an object of type PingAccessAgent. Field deprecated in 30.2.1. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
saml
tacacs_plus
It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Type of the Auth Profile. Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML, AUTH_PROFILE_PINGACCESS, AUTH_PROFILE_JWT, AUTH_PROFILE_OAUTH. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- AUTH_PROFILE_LDAP,AUTH_PROFILE_TACACS_PLUS,AUTH_PROFILE_SAML,AUTH_PROFILE_JWT,AUTH_PROFILE_OAUTH), Basic edition(Allowed values- AUTH_PROFILE_LDAP,AUTH_PROFILE_TACACS_PLUS,AUTH_PROFILE_SAML,AUTH_PROFILE_JWT,AUTH_PROFILE_OAUTH), Enterprise with Cloud Services edition.
url
UUID of the Auth Profile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
log in failed
curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","type:"string"}' https://{api_host}/api/authprofile/{uuid}