ADD EPV USERS TO CYBERARK

USE THIS FUNCTION TO ADD EPV USERS INTO CYBERARK

Add-VPASEPVUser -Username <String> [-UserType <String>] [-Location <String>] [-InitialPassword <String>] [-PasswordNeverExpires] [-ChangePasswordOnTheNextLogon] [-DisableUser] [-Description <String>] [-Street <String>] [-City <String>] [-State <String>] [-Zip <String>] [-Country <String>] [-Title <String>] [-Organization <String>] [-Department

<String>] [-Profession <String>] [-FirstName <String>] [-MiddleName <String>] [-LastName <String>] [-HomeNumber <String>] [-BusinessNumber <String>] [-CellularNumber <String>] [-FaxNumber <String>] [-PagerNumber <String>] [-HomePage <String>] [-HomeEmail <String>] [-BusinessEmail <String>] [-OtherEmail <String>] [-WorkStreet <String>] [-WorkCity

<String>] [-WorkState <String>] [-WorkZip <String>] [-WorkCountry <String>] [-AddSafes] [-AuditUsers] [-AddUpdateUsers] [-ResetUsersPasswords] [-ActivateUsers] [-AddNetworkAreas] [-ManageDirectoryMapping] [-ManageServerFileCategories] [-BackupAllSafes] [-RestoreAllSafes] [-AuthenticationType <String>] [-DistinguishedName <String>] [-token

<Hashtable>] [<CommonParameters>]

Add-VPASEPVUser -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]

-Username <String>
Username that will be assigned to the new EPVUser

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-UserType <String>
The user type of the EPVUser being created
UserTypes are determined by the current license in the environment, as well as how many seats are available per UserType
Possible values: EPVUser, AIMAccount, CPM, PVWA, PSMHTML5Gateway, PSM, AppProvider, OPMProvider, CCPEndpoints, PSMUser, IBVUser, AutoIBVUser, CIFS, FTP, SFE, DCAUser, DCAInstance, SecureEpClientUser, ClientlessUser, AdHocRecipient, SecureEmailUser, SEG, PSMPADBridge, PSMPServer, AllUsers, DR_USER, BizUser, PTA, DiscoveryApp, xRayAdminApp, PSMWeb, EPMUser, DAPService

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-Location <String>
Where the EPVUser will reside in terms of the directory structure within CyberArk

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-InitialPassword <String>
Temporary initial password of the EPVUser

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-PasswordNeverExpires [<SwitchParameter>]
If the password will ever expire or follow a scheduled expiry schedule

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-ChangePasswordOnTheNextLogon [<SwitchParameter>]
Change the password of the new EPVUser upon first time login

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-DisableUser [<SwitchParameter>]
Disable the the new EPVUser account
Disabled accounts are NOT able to log into CyberArk

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-Description <String>
An explanation/details of the target resource
Best practice states to leave informative descriptions to help identify the resource purpose

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-Street <String>
EPVUser Street value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-City <String>
EPVUser City value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-State <String>
EPVUser State value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-Zip <String>
EPVUser Zip value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-Country <String>
EPVUser Country value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-Title <String>
EPVUser Title value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-Organization <String>
EPVUser Organization value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-Department <String>
EPVUser Department value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-Profession <String>
EPVUser Profession value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-FirstName <String>
EPVUser FirstName value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-MiddleName <String>
EPVUser MiddleName value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-LastName <String>
EPVUser LastName value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-HomeNumber <String>
EPVUser HomeNumber value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-BusinessNumber <String>
EPVUser BusinessNumber value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-CellularNumber <String>
EPVUser CellularNumber value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-FaxNumber <String>
EPVUser FaxNumber value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-PagerNumber <String>
EPVUser PagerNumber value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-HomePage <String>
EPVUser HomePage value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-HomeEmail <String>
EPVUser HomeEmail value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-BusinessEmail <String>
EPVUser BusinessEmail value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-OtherEmail <String>
EPVUser OtherEmail value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-WorkStreet <String>
EPVUser WorkStreet value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-WorkCity <String>
EPVUser WorkCity value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-WorkState <String>
EPVUser WorkState value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-WorkZip <String>
EPVUser WorkZip value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-WorkCountry <String>
EPVUser WorkCountry value

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-AddSafes [<SwitchParameter>]
VaultAuthorization permission that gives rights for an EPVUser to create safes

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-AuditUsers [<SwitchParameter>]
VaultAuthorization permission that gives rights for an EPVUser to view other EPVUser details

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-AddUpdateUsers [<SwitchParameter>]
VaultAuthorization permission that gives rights for an EPVUser to add new EPVUsers or update existing EPVUsers

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-ResetUsersPasswords [<SwitchParameter>]
VaultAuthorization permission that gives rights for an EPVUser to reset credentials for other EPVUsers

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-ActivateUsers [<SwitchParameter>]
VaultAuthorization permission that gives rights for an EPVUser to Activate other EPVUsers (if the EPVUser becomes inactive)

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-AddNetworkAreas [<SwitchParameter>]
VaultAuthorization permission that gives rights for an EPVUser to create Networking Areas
Networking Areas limit where an account can be used from

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-ManageDirectoryMapping [<SwitchParameter>]
VaultAuthorization permission that gives rights for an EPVUser to create/edit/delete directory mappings created during LDAP integration

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-ManageServerFileCategories [<SwitchParameter>]
VaultAuthorization permission that gives rights for an EPVUser to create/modify/delete ServerFileCategories

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-BackupAllSafes [<SwitchParameter>]
VaultAuthorization permission that gives rights for an EPVUser to be able to backup an existing safe

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-RestoreAllSafes [<SwitchParameter>]
VaultAuthorization permission that gives rights for an EPVUser to be able to restore safes

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-AuthenticationType <String>
Authentication method that the EPVUser will login with

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-DistinguishedName <String>
Users distinguished name, used for PKI authentication
This should match the Certificate SubjectName or Domain Name

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-InputParameters <Hashtable>
HashTable of values containing the parameters required to make the API call

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-token <Hashtable>
HashTable of data containing various pieces of login information (PVWA, LoginToken, HeaderType, etc).
If -token is not passed, function will use last known hashtable generated by New-VPASToken

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug
ErrorAction, ErrorVariable, WarningAction, WarningVariable
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216)

$EPVUserJSON = Add-VPASEPVUser -Username {USERNAME VALUE}

$InputParameters = @{
        Username = "NewEPVUser"
         UserType = "EPVUser"
         Location = "Location" #Default is "//"
         InitialPassword = "Cyberark1"
         PasswordNeverExpires = $true|$false
         ChangePasswordOnTheNextLogon = $true|$false
         DisableUser = $true|$false
         Description = "Description of new EPVUser"
         Street = "User Street"
         City = "City Here"
         State = "State Here"
         Zip = "12345"
         Country = "Country Here"
         Title = "Title Here"
         Organization = "Organization Here"
         Department = "Department Here"
         Profession = "Profession Here"
         FirstName = "Firstname Here"
         MiddleName = "Middlename Here"
         LastName = "Lastname Here"
         HomeNumber = "123-456-78901"
         BusinessNumber = "123-456-7890"
         CellularNumber = "123-456-7890"
         FaxNumber = "123-456-7890"
         PagerNumber = "123-456-7890"
         HomePage = "HomePage Here"
         HomeEmail = "HomeEmailHere@vman.com"
         BusinessEmail = "BusinessEmailHere@vman.com"
         OtherEmail = "OtherEmailHere@vman.com"
         WorkStreet = "WorkStreet Here"
         WorkCity = "WorkCity Here"
         WorkState = "WorkState Here"
         WorkZip = "WorkZip Here"
         WorkCountry = "WorkCountry Here"
         AddSafes = $true|$false
         AuditUsers = $true|$false
         AddUpdateUsers = $true|$false
         ResetUsersPasswords = $true|$false
         ActivateUsers = $true|$false
         AddNetworkAreas = $true|$false
         ManageDirectoryMapping = $true|$false
         ManageServerFileCategories = $true|$false
         BackupAllSafes = $true|$false
         RestoreAllSafes = $true|$false
         AuthenticationType = "AuthTypePass"|"AuthTypeRadius"|"AuthTypeLDAP"
         DistinguishedName = "NewEPVUser"
}
$EPVUserJSON = Add-VPASEPVUser -InputParameters $InputParameters

If successful:
{
         "enableUser": true,
         "changePassOnNextLogon": false,
         "expiryDate": null,
         "suspended": false,
         "lastSuccessfulLoginDate": 1723779044,
         "unAuthorizedInterfaces": [
                
         ],
         "authenticationMethod": [
                 "AuthTypePass"
         ],
         "passwordNeverExpires": false,
         "distinguishedName": "",
         "description": "New user for documentation",
         "businessAddress": {
                 "workStreet": "",
                 "workCity": "",
                 "workState": "",
                 "workZip": "",
                 "workCountry": ""
         },
         "internet": {
                 "homePage": "",
                 "homeEmail": "",
                 "businessEmail": "",
                 "otherEmail": ""
         },
         "phones": {
                 "homeNumber": "",
                 "businessNumber": "",
                 "cellularNumber": "",
                 "faxNumber": "",
                 "pagerNumber": ""
         },
         "personalDetails": {
                 "street": "",
                 "city": "",
                 "state": "",
                 "zip": "",
                 "country": "",
                 "title": "",
                 "organization": "",
                 "department": "",
                 "profession": "",
                 "firstName": "",
                 "middleName": "",
                 "lastName": ""
         },
         "id": 245,
         "username": "NewUser",
         "source": "CyberArk",
         "userType": "EPVUser",
         "componentUser": false,
         "groupsMembership": [
                
         ],
         "vaultAuthorization": [
                
         ],
         "location": "\\"
}

$false if failed