ADD SAFE MEMBER

USE THIS FUNCTION TO ADD A SAFE MEMBER TO AN EXISTING SAFE IN CYBERARK WITH SPECIFIED PERMISSIONS

Add-VPASSafeMember -member <String> -safe <String> -MemberType <String> [-searchin <String>] [-AllPerms] [-AllAccess] [-AllAccountManagement] [-AllMonitor] [-AllSafeManagement] [-AllWorkflow] [-AllAdvanced] [-UseAccounts] [-RetrieveAccounts] [-ListAccounts] [-AddAccounts] [-UpdateAccountContent] [-UpdateAccountProperties]

[-InitiateCPMAccountManagementOperations] [-SpecifyNextAccountContent] [-RenameAccounts] [-DeleteAccounts] [-UnlockAccounts] [-ManageSafe] [-ManageSafeMembers] [-BackupSafe] [-ViewAuditLog] [-ViewSafeMembers] [-AccessWithoutConfirmation] [-CreateFolders] [-DeleteFolders] [-MoveAccountsAndFolders] [-RequestsAuthorizationLevel1]

[-RequestsAuthorizationLevel2] [-token <Hashtable>] [<CommonParameters>]

Add-VPASSafeMember -member <String> -safe <String> -MemberType <String> [-searchin <String>] -SafePermissionHashTable <Hashtable> [-token <Hashtable>] [<CommonParameters>]

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

-member <String>
Target unique safe member name

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

-safe <String>
Target unique safe name

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

-MemberType <String>
Specify whether the target safe member is of type User, Group, or Role.
This will save time querying for the targe safe member.
Possible values: "User", "Group", "Role"

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

-searchin <String>
Which directory to search in for the target safe member. This value is defined during LDAP integration.
If searching for a user internally use the value "vault"

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

-AllPerms [<SwitchParameter>]
Enables all safe permissions

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

-AllAccess [<SwitchParameter>]
Enables all Access safe permissions (UseAccounts, RetrieveAccounts, ListAccounts)

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

-AllAccountManagement [<SwitchParameter>]
Enables all AccountManagement safe permissions (AddAccounts, UpdateAccountContent, UpdateAccountProperties, InitiateCPMAccountManagementOperations, SpecifyNextAccountContent, RenameAccounts, DeleteAccounts, UnlockAccounts)

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

-AllMonitor [<SwitchParameter>]
Enables all Monitor safe permissions (ViewAuditLog, ViewSafeMembers)

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

-AllSafeManagement [<SwitchParameter>]
Enables all SafeManagement safe permissions (ManageSafe, ManageSafeMembers, BackupSafe)

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

-AllWorkflow [<SwitchParameter>]
Enables all Workflow safe permissions (RequestsAuthorizationLevel1, AccessWithoutConfirmation)

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

-AllAdvanced [<SwitchParameter>]
Enables all Advanced safe permissions (CreateFolders, DeleteFolders, MoveAccountsAndFolders)

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

-UseAccounts [<SwitchParameter>]
Gives the ability use accounts in a safe (click the connect button)

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

-RetrieveAccounts [<SwitchParameter>]
Gives the ability to pull accounts credentials in a safe (click the Show/Copy buttons)

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

-ListAccounts [<SwitchParameter>]
Gives the ability to view accounts in a safe

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

-AddAccounts [<SwitchParameter>]
Gives the ability to add accounts in a safe

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

-UpdateAccountContent [<SwitchParameter>]
Gives the ability to manually update accounts secrets in a safe

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

-UpdateAccountProperties [<SwitchParameter>]
Gives the ability to update account properties in a safe (username field, address field, etc)

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

-InitiateCPMAccountManagementOperations [<SwitchParameter>]
Gives the ability to trigger the CPM to run a change, verify, or reconcile on accounts in a safe

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

-SpecifyNextAccountContent [<SwitchParameter>]
Gives the ability to specify what the next password the CPM will push to accounts in a safe

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

-RenameAccounts [<SwitchParameter>]
Gives the ability to modify the ObjectName of accounts in a safe

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

-DeleteAccounts [<SwitchParameter>]
Gives the ability to delete accounts from a safe

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

-UnlockAccounts [<SwitchParameter>]
Gives the ability to unlock or check-in locked account on someone else's behalf in a safe

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

-ManageSafe [<SwitchParameter>]
Gives the ability to modify safe details (DaysRetention, VersionRetention, Description, etc)

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

-ManageSafeMembers [<SwitchParameter>]
Gives the ability to add, remove, modify safe members on a safe

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

-BackupSafe [<SwitchParameter>]
Gives the ability to backup a safe

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

-ViewAuditLog [<SwitchParameter>]
Gives the ability to view the activities performed on accounts in a safe

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

-ViewSafeMembers [<SwitchParameter>]
Gives the ability to view safe members on a safe

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

-AccessWithoutConfirmation [<SwitchParameter>]
Gives the ability to access the safe without needing confirmation from an approver

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

-CreateFolders [<SwitchParameter>]
Gives the ability to create folders in a safe

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

-DeleteFolders [<SwitchParameter>]
Gives the ability to delete folders from a safe

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

-MoveAccountsAndFolders [<SwitchParameter>]
Gives the ability to move accounts and folders from one safe to another

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

-RequestsAuthorizationLevel1 [<SwitchParameter>]
Gives the ability to approve or deny users from using an account (Level1) in a safe

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

-RequestsAuthorizationLevel2 [<SwitchParameter>]
Gives the ability to approve or deny users from using an account (Level2) in a safe

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

-SafePermissionHashTable <Hashtable>
Hashtable that contains the set of safe permissions to be applied to a specific safe member.
Hashtable has priority over the safe permission flags that are passed

Required: true
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)

$AddSafemember = Add-VPASSafeMember -member {MEMBER VALUE} -MemberType {MEMBERTYPE VALUE} -safe {SAFE VALUE} -UseAccounts -RetrieveAccounts -ListAccounts

$AddSafemember = Add-VPASSafeMember -member {MEMBER VALUE} -MemberType {MEMBERTYPE VALUE} -safe {SAFE VALUE} -AllAccess -AllMonitor

$InputParameters = @{
        member = "TargetUser@vman.com"
         safe = "TargetSafe"
         MemberType = "User"|"Group"|"Role"
         AllPerms = $true|$false
         AllAccess = $true|$false
         AllAccountManagement = $true|$false
         AllMonitor = $true|$false
         AllSafeManagement = $true|$false
         AllWorkflow = $true|$false
         AllAdvanced = $true|$false
         UseAccounts = $true|$false
         RetrieveAccounts = $true|$false
         ListAccounts = $true|$false
         AddAccounts = $true|$false
         UpdateAccountContent = $true|$false
         UpdateAccountProperties = $true|$false
         InitiateCPMAccountManagementOperations = $true|$false
         SpecifyNextAccountContent = $true|$false
         RenameAccounts = $true|$false
         DeleteAccounts = $true|$false
         UnlockAccounts = $true|$false
         ManageSafe = $true|$false
         ManageSafeMembers = $true|$false
         BackupSafe = $true|$false
         ViewAuditLog = $true|$false
         ViewSafeMembers = $true|$false
         AccessWithoutConfirmation = $true|$false
         CreateFolders = $true|$false
         DeleteFolders = $true|$false
         MoveAccountsAndFolders = $true|$false
         RequestsAuthorizationLevel1 = $true|$false
         RequestsAuthorizationLevel2 = $true|$false
}
$AddSafemember = Add-VPASSafeMember -InputParameters $InputParameters

$InputParameters = @{
        member = "TargetUser@vman.com"
         safe = "TargetSafe"
         MemberType = "User"|"Group"|"Role"
         SafePermissionHashTable = @{
                 UseAccounts = $true|$false
                 RetrieveAccounts = $true|$false
                 ListAccounts = $true|$false
                 AddAccounts = $true|$false
                 UpdateAccountContent = $true|$false
                 UpdateAccountProperties = $true|$false
                 InitiateCPMAccountManagementOperations = $true|$false
                 SpecifyNextAccountContent = $true|$false
                 RenameAccounts = $true|$false
                 DeleteAccounts = $true|$false
                 UnlockAccounts = $true|$false
                 ManageSafe = $true|$false
                 ManageSafeMembers = $true|$false
                 BackupSafe = $true|$false
                 ViewAuditLog = $true|$false
                 ViewSafeMembers = $true|$false
                 AccessWithoutConfirmation = $true|$false
                 CreateFolders = $true|$false
                 DeleteFolders = $true|$false
                 MoveAccountsAndFolders = $true|$false
                 RequestsAuthorizationLevel1 = $true|$false
                 RequestsAuthorizationLevel2 = $true|$false
         }
}
$AddSafemember = Add-VPASSafeMember -InputParameters $InputParameters

If successful:
{
         "safeUrlId": "NewSafeVpas",
         "safeName": "NewSafeVpas",
         "safeNumber": 133,
         "memberId": "1dfc3edf-4564-4abf-9bc1-aa07b8c62afc",
         "memberName": "vadim@vman.pam",
         "memberType": "User",
         "membershipExpirationDate": null,
         "isExpiredMembershipEnable": false,
         "isPredefinedUser": false,
         "isReadOnly": false,
         "permissions": {
                 "useAccounts": true,
                 "retrieveAccounts": true,
                 "listAccounts": true,
                 "addAccounts": false,
                 "updateAccountContent": false,
                 "updateAccountProperties": false,
                 "initiateCPMAccountManagementOperations": false,
                 "specifyNextAccountContent": false,
                 "renameAccounts": false,
                 "deleteAccounts": false,
                 "unlockAccounts": false,
                 "manageSafe": false,
                 "manageSafeMembers": false,
                 "backupSafe": false,
                 "viewAuditLog": false,
                 "viewSafeMembers": false,
                 "accessWithoutConfirmation": false,
                 "createFolders": false,
                 "deleteFolders": false,
                 "moveAccountsAndFolders": false,
                 "requestsAuthorizationLevel1": false,
                 "requestsAuthorizationLevel2": false
         }
}

$false if failed