Package com.veeva.vault.vapil.api.request

Class SecurityPolicyRequest

java.lang.Object
com.veeva.vault.vapil.api.request.VaultRequest<SecurityPolicyRequest>
com.veeva.vault.vapil.api.request.SecurityPolicyRequest
public class SecurityPolicyRequest extends VaultRequest<SecurityPolicyRequest>
All Security Policy requests
Vault API Coverage:
https://developer.veevavault.com/api/25.1/#retrieve-all-security-policies

  • Method Details

    • retrieveSecurityPolicyMetaData

      public MetaDataSecurityPolicyResponse retrieveSecurityPolicyMetaData()
      Retrieve Security Policy Metadata
      Returns:
      MetaDataSecurityPolicyResponse
      Vault API Endpoint:
       GET /api/{version}/metadata/objects/securitypolicies
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#retrieve-security-policy-metadata
      Example Request:
       SecurityPolicyRequest request = vaultClient.newRequest(SecurityPolicyRequest.class).retrieveSecurityPolicyMetaData();
      Example Response:
      System.out.println("Retrieving Security Policy Metadata");
 MetaDataSecurityPolicyResponse response = request.retrieveSecurityPolicyMetaData();

 System.out.println("Security Policy Metadata:");
 MetaDataSecurityPolicyResponse.Metadata metadata = response.getMetadata();
 System.out.println("\tName: " + metadata.getName());
 System.out.println("\tDescription: " + metadata.getDescription());

 List<MetaDataSecurityPolicyResponse.SecurityPolicy.Property> properties = metadata.getProperties();
 properties.forEach(property -> {
   System.out.println(property.getName());
   System.out.println(property.getDescription());
 });

 List<MetaDataSecurityPolicyResponse.SecurityPolicy.Object> objects = metadata.getObjects();
 objects.forEach(object -> {
   System.out.println(object.getName());
   System.out.println(object.getDescription());
 }

    • retrieveAllSecurityPolicies

      public SecurityPoliciesResponse retrieveAllSecurityPolicies()
      Retrieve All Security Policies
      Returns:
      SecurityPoliciesResponse
      Vault API Endpoint:
       GET /api/{version}/objects/securitypolicies
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#retrieve-all-security-policies
      Example Request:
       SecurityPolicyRequest request = vaultClient.newRequest(SecurityPolicyRequest.class).retrieveAllSecurityPolicies();
      Example Response:
      System.out.println("Retrieving all Security policies");
 SecurityPoliciesResponse response = request.retrieveAllSecurityPolicies();

 System.out.println("Security Policies:");
 for (SecurityPolicy sp : response.getSecurityPolicies){
   System.out.println("\tName:  " + sp.getName());
   System.out.println("\tLabel:  " + sp.getLabel());
   System.out.println("\tValue:  " + sp.getValue());
 }

    • retrieveSecurityPolicy

      public SecurityPolicyResponse retrieveSecurityPolicy(String securityPolicyName)
      Retrieve Security Policy

      Depending on the configuration, the response may include some or all of the parameters in SecurityPolicyResponse.SecurityPolicy.PolicySecuritySettings

      Parameters:
      securityPolicyName - Name of the Security Policy
      Returns:
      SecurityPolicyResponse
      Vault API Endpoint:
       GET /api/{version}/objects/securitypolicies/{security_policy_name}
      Vault API Help Link:
      https://developer.veevavault.com/api/25.1/#retrieve-security-policy
      Example Request:
       SecurityPolicyRequest request = vaultClient.newRequest(SecurityPolicyRequest.class).retrieveSecurityPolicy(name);
      Example Response:
      System.out.println("Retrieving Security policy " + name);
 SecurityPolicyResponse response = request.retrieveSecurityPolicy(name);
 System.out.println("Security Policy:");
 SecurityPolicyResponse.SecurityPolicy securityPolicy = response.getSecurityPolicy();
 System.out.println("\tPolicy Details:");
 SecurityPolicyResponse.SecurityPolicy.PolicyDetails policyDetails = securityPolicy.getPolicyDetails();
 System.out.println("\t\tName:  " + policyDetails.getName());
 System.out.println("\t\tLabel:  " + policyDetails.getLabel());
 System.out.println("\t\tDescription:  " + policyDetails.getDescription());
 System.out.println("\t\tIs Active:" + policyDetails.getIsActive());
 System.out.println("\tPolicy Security Settings:");
 SecurityPolicyResponse.SecurityPolicy.PolicySecuritySettings policySecuritySettings = securityPolicy.getPolicySecuritySettings();
 System.out.println("\t\tAuthentication Type:  ");
 SecurityPolicyResponse.SecurityPolicy.PolicySecuritySettings.AuthenticationType authenticationType = policySecuritySettings.getAuthenticationType();
 System.out.println("\t\t\tName:  " + authenticationType.getName());
 System.out.println("\t\t\tLabel:  " + authenticationType.getLabel());
 System.out.println("\t\tPasswords Require Number:  " + policySecuritySettings.getPasswordsRequireNumber());
 System.out.println("\t\tPasswords Require Uppercase Letter:  " + policySecuritySettings.getPasswordsRequireUpperCaseLetter());
 System.out.println("\t\tPasswords Require Non-Alphanumeric Character:  " + policySecuritySettings.getPasswordsRequireNonAlphaChar());
 System.out.println("\t\tMinimum Password Length:  " + policySecuritySettings.getMinPasswordLength());
 System.out.println("\t\tPassword Expiration:  " + policySecuritySettings.getPasswordExpiration());
 System.out.println("\t\tPassword History Reuse:  " + policySecuritySettings.getPasswordHistoryReuse());
 System.out.println("\t\tRequire Question on Password Reset:  " + policySecuritySettings.getRequireQuestionOnPasswordReset());
 System.out.println("\t\tAllow Delegated Auth SFDC:  " + policySecuritySettings.getAllowDelegatedAuthSFDC());
 System.out.println("\t\tSalesforce Org ID:  " + policySecuritySettings.getSfdcOrgId());