User Guide > User Guide > DataCloud API User Guide > ACL Service API > Provisioning Permissions
Was this helpful?
Provisioning Permissions
The methods listed on this page allow ACL operations for the provisioning entity.
Note:  The following imports are required for all of the Java code examples on this page.
import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import com.pervasive.datacloud2.schema.api.acl.v1.ACLService;
import com.pervasive.datacloud2.schema.api.acl.v1.ACLServicePortBindingStub;
import com.pervasive.datacloud2.schema.api.acl.v1.ACLServiceService;
import com.pervasive.datacloud2.schema.api.acl.v1.ACLServiceServiceLocator;
import com.pervasive.datacloud2.schema.api.acl.v1.InvalidSessionException;
import com.pervasive.datacloud2.schema.api.acl.v1.Action;
Tip...  Use the Entity API Service login method to start a session and obtain the sessionId parameter required for the ACL Service API methods. See Login and Logout.
setProvisioningPermission
Assign access permission on a specified provisioning to a user.
Parameters
 
Name
Type
Description
id
Long
ID of the provisioning.
user
Long
ID of the user.
permission
String
Permission to set.
sessionId
String
ID of the current user session.
Example
SOAP Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://datacloud2.pervasive.com/schema/api/acl/v1/">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:setProvisioningPermission>
         <id>12086</id>
         <user>171</user>
         <permission>READ</permission>
         <sessionId>060cc0a2-ebd6-4e60-818e-1bec33053a4a</sessionId>
      </v1:setProvisioningPermission>
   </soapenv:Body>
</soapenv:Envelope>
SOAP Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:setProvisioningPermissionResponse xmlns:ns2="http://datacloud2.pervasive.com/schema/api/acl/v1/" xmlns:ns3="http://datasolutions.pervasive.com/api/crud"/>
   </S:Body>
</S:Envelope>
Java Code Sample
final long id = 12086;
final long user = 171;
final String permission = "READ";
final String sessionId = "060cc0a2-ebd6-4e60-818e-1bec33053a4a";
ACLServiceServiceLocator service = new ACLServiceServiceLocator();
ACLService stub = service.getACLServicePort();
stub.setProvisioningPermission(id, user, permission, sessionId);
getProvisioningACL
List the access permissions attached to a specified provisioning.
Parameters
 
Name
Type
Description
id
Long
ID of the provisioning.
sessionId
String
ID of the current user session.
Returns
 
Name
Type
Description
ACLPermisssions
ACLProxy
List of ACL entries attached to the requested provisioning.
Example
SOAP Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://datacloud2.pervasive.com/schema/api/acl/v1/">
    <soapenv:Header/>
    <soapenv:Body>
        <v1:getProvisioningACL>
            <id>12086</id>
            <sessionId>060cc0a2-ebd6-4e60-818e-1bec33053a4a</sessionId>
        </v1:getProvisioningACL>
    </soapenv:Body>
</soapenv:Envelope>
SOAP Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
   <ns2:getProvisioningACLResponse xmlns:ns2="http://datacloud2.pervasive.com/schema/api/acl/v1/" xmlns:ns3="http://datasolutions.pervasive.com/api/crud">
      <return>
         <ns2:entry user="171">
            <ns2:permission>READ</ns2:permission>
         </ns2:entry>
         <ns2:entry user="995">
            <ns2:permission>READ</ns2:permission>
         </ns2:entry>
         <ns2:entry user="335">
            <ns2:permission>READ</ns2:permission>
            <ns2:permission>WRITE</ns2:permission>
            <ns2:permission>EXECUTE</ns2:permission>
            <ns2:permission>GRANT</ns2:permission>
         </ns2:entry>
      </return>
   </ns2:getProvisioningACLResponse>
</S:Body>
</S:Envelope>
Java Code Sample
final long id = 12086;
final String sessionId = "060cc0a2-ebd6-4e60-818e-1bec33053a4a";
ACLServiceServiceLocator service = new ACLServiceServiceLocator();
ACLService stub = service.getACLServicePort();
String provisioningValue[][] = stub.getProvisioningACL(id, sessionId);
hasAccessToProvisioning
Check whether a specified provisioning has a permission.
Parameters
 
Name
Type
Description
Required?
verb
Action
Access permission to check.
Yes.
id
Long
ID of the provisioning.
Yes.
sessionId
String
ID of the current user session.
Yes.
Returns
 
Name
Type
Description
Permission State
Boolean
Returns true if the provisioning has the specified permission.
Example
SOAP Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://datacloud2.pervasive.com/schema/api/acl/v1/">
    <soapenv:Header/>
    <soapenv:Body>
        <v1:hasAccessToProvisioning>
            <verb>READ</verb>
            <provisioningId>12086</provisioningId>
            <sessionId>060cc0a2-ebd6-4e60-818e-1bec33053a4a</sessionId>
        </v1:hasAccessToProvisioning>
    </soapenv:Body>
</soapenv:Envelope>
SOAP Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:hasAccessToProvisioningResponse xmlns:ns2="http://datacloud2.pervasive.com/schema/api/acl/v1/" xmlns:ns3="http://datasolutions.pervasive.com/api/crud">
            <return>true</return>
        </ns2:hasAccessToProvisioningResponse>
    </S:Body>
</S:Envelope>
Java Code Sample
final String verb = "READ";
final long id = 12086;
final String sessionId = "060cc0a2-ebd6-4e60-818e-1bec33053a4a";
ACLServiceServiceLocator service = new ACLServiceServiceLocator();
ACLService stub = service.getACLServicePort();
Boolean provisioningAccess = stub.hasAccessToProvisioning(Action.fromString(verb), id, sessionId);
clearProvisioningPermission
Remove a permission from a specific provisioning for a user.
Parameters
 
Name
Type
Description
Required?
id
Long
ID of the provisioning.
Yes.
user
Long
ID of the user.
Yes.
permission
String
Permission to clear.
Yes.
sessionId
String
ID of the current user session.
Yes.
Example
SOAP Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://datacloud2.pervasive.com/schema/api/acl/v1/">
    <soapenv:Header/>
    <soapenv:Body>
        <v1:clearProvisioningPermission>
            <id>12086</id>
            <user>171</user>
            <permission>READ</permission>
            <sessionId>060cc0a2-ebd6-4e60-818e-1bec33053a4a</sessionId>
        </v1:clearProvisioningPermission>
    </soapenv:Body>
</soapenv:Envelope>
SOAP Response
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:clearProvisioningPermissionResponse xmlns:ns2="http://datacloud2.pervasive.com/schema/api/acl/v1/" xmlns:ns3="http://datasolutions.pervasive.com/api/crud"/>
   </S:Body>
</S:Envelope>
Java Code Sample
final long id = 12086;
final long user = 171;
final String permission = "READ";
final String sessionId = "060cc0a2-ebd6-4e60-818e-1bec33053a4a";
ACLServiceServiceLocator service = new ACLServiceServiceLocator();
ACLService stub = service.getACLServicePort();
stub.clearProvisioningPermission(id, user, permission, sessionId);
Last modified date: 12/17/2021