The userAuthenticationSettings Web API Method

Modify current authentication settings, allowing the user to switch between simple and extended authentication and authorization schemes.

Version: 1.3

Required Permissions: Full

HTTP method: POST

Supported by Editions: All

Request Parameters:

Parameter	Type	Required	Description
type	Enum	Yes	One of : simple, extended
ldap	Array	Yes	Array of ldap properties: host: host, ip or location of the active directory port: port part of the URL above encryption: ssl - use SSL to secure communications tls - start TLS to secure communications none - no encryption is used username: directory username, broken to CN and DC parts for use in querying the active directory password: matching password for the above username baseDn: DN broken down to CN and DC parts for using during user authentication bindRequiresDn: 0 for use with Active Directory, 1 for use with other LDAP services groupsAttribute: Name for a list of user groups’ membership
password	String	Yes	Current user’s password for authentication
confirmNewPassword	String	Yes	Confirmation of new password

Expected Response Code: 200 OK. For more information see Response Format.

Response Format: userSetPassword

Possible Action Specific Error Codes: This action has no specific error codes

Example

Usage Example

Request

GET /ZendServer/Api/userAuthenticationSettings

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName><![CDATA[Admin]]></apiKeyName>
		<method>userAuthenticationSettings</method>
	</requestData>
	<responseData>
		<authenticationType>Simple</authenticationType>
	</responseData>
</zendServerAPIResponse>