WebAPI Reference Guide > Available API Methods > Administration Methods > The aclSetGroups Method

The aclSetGroups Method

Store a set of group mappings for resolving user roles during authentication. These groups correspond to roles within the system or to applications that implicitly grant the developerLimited role to the user.

Version: 1.3

Required Permissions: Full

HTTP method: POST

Supported by Editions: All

Request Parameters:

Parameter

 Type

Required

Description

role_groups

Array

Yes

An associative list of role names and their corresponding group.

app_groups

Array

No

An associative list of application IDs (numbers) and their corresponding group.

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

Response Type: aclGroups

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

Example

Usage Example

Request

GET /ZendServer/Api/userSetAclGroups

Response

?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName><![CDATA[Admin]]></apiKeyName>
		<method>aclSetGroups</method>
	</requestData>
	<responseData>
		<roleGroups>
			<parameter>
				<name>administrator</name>
				<value><![CDATA[Zend Server-Admin]]></value>
			</parameter>
			<parameter>
				<name>developer</name>
				<value><![CDATA[Zend Server-Dev]]></value>
			</parameter>
		</roleGroups>
	<applicationGroups>
		<parameter>
			<name>14</name>
			<value><![CDATA[Zend Server-Dev14]]></value>
		</parameter>
	</applicationGroups>
	</responseData>
</zendServerAPIResponse>

 

 

Related Links

Related Links:

Available API Methods

 

 

 

© 1999-2013 Zend Technologies, Ltd. All rights reserved.