Administering an Encyclopedia volume : Administering security and authentication operations : Getting an access control list : Getting a user’s ACL template
 
Getting a user’s ACL template
GetFileCreationACL retrieves a user’s ACL template. The ACL template is the access rights that apply to a file the user creates in an Encyclopedia volume. You can specify the user by either ID or name.
<SOAP-ENV:Body>
<GetFileCreationACL>
<CreatedByUserName>Wenfeng Chan</CreatedByUserName>
</GetFileCreationACL>
</SOAP-ENV:Body>
The response returns the privileges that apply to the user’s new files. In the following example, the privileges include visible, read, write, execute, and delete. If the list exceeds the allowable maximum number of items to fetch, the response includes a FetchHandle to support retrieving the remaining items.
<SOAP-ENV:Body>
<GetFileCreationACLResponse>
<ACL>
<Permission>
<AccessRight>VRWED</AccessRight>
</Permission>
</ACL>
<TotalCount>1</TotalCount>
</GetFileCreationACLResponse>
</SOAP-ENV:Body>
Setting an additional condition on an ACL request
Typically, a request for an ACL returns all the permissions that apply to an item. The request returns the permissions for every user and every security role with access to the item. You can, however, restrict a result to the permissions that apply to a specific user or security role.
Using GetFileCreationACL, you can request privileges granted to a user or a security role for files a specific user creates. For example, you can extend the request to ask for the rights granted to the Engineering security role for a file that Wenfeng Chan created. Specify the security role and user by name or ID.
<SOAP-ENV:Body>
<GetFileCreationACL>
<CreatedByUserName>Wenfeng Chan</CreatedByUserName>
<GrantedRoleName>Engineering</GrantedRoleName>
</GetFileCreationACL>
</SOAP-ENV:Body>
The preceding request returns the rights granted to Engineering for files Wenfeng Chan creates. In this example, the rights are Visible and Secure Read:
<SOAP-ENV:Body>
<GetFileCreationACLResponse>
<ACL>
<Permission>
<GrantedRoleName>Engineering</GrantedRoleName>
<AccessRight>VSR</AccessRight>
</Permission>
</ACL>
<TotalCount>1</TotalCount>
</GetFileCreationACLResponse>
</SOAP-ENV:Body>
Using GetChannelACL, you can determine what permissions a user or security role has to a channel by specifying GrantedUserName, GrantedUserId, GrantedRoleName, or GrantedRoleId:
<SOAP-ENV:Body>
<GetChannelACL>
<ChannelName>BargainBooks</ChannelName>
<GrantedUserName>Colin Drey</GrantedUserName>
</GetChannelACL>
</SOAP-ENV:Body>
The preceding request returns the privileges for the user or security role and a TotalCount:
<SOAP-ENV:Body>
<GetChannelACLResponse>
<ACL>
<Permission>
<GrantedUserName>Colin Drey</GrantedUserName>
<AccessRight>RW</AccessRight>
</Permission>
</ACL>
<TotalCount>1</TotalCount>
</GetChannelACLResponse>
</SOAP-ENV:Body>