IdentityCommand.DPA [Work in Progress] is a PowerShell module that provides a set of easy-to-use commands, allowing you to interact with the API for a CyberArk Dynamic Privileged Access from within the PowerShell environment.

• Prior to a Version 1.0.0 release:
  • Expect changes
  • Things may break
  • Issues / PRs are encouraged & appreciated

• To develop & publish consistently coded PowerShell functions for available CyberArk DPA APIs.

The module requires authentication to the CyberArk Identity platform using the IdentityCommand module.

After authentication to an Identity tenant using the IdentityCommand module, the Connect-DPATenant command is used to initialise a bearer token to be used for module operations against the DPA service:

Connect-DPATenant -tenant_url https://sometenant.dpa.cyberark.cloud

The Get-DPASession command can be used to return data from the module scope:

PS C:\> Get-IDSession

Name                           Value
----                           -----
tenant_url                     https://abc1234.dpa.cyberark.cloud
User                           some.user@somedomain.com
TenantId
SessionId
WebSession                     Microsoft.PowerShell.Commands.WebRequestSession
StartTime                      12/02/2024 22:58:13
ElapsedTime                    00:25:30
LastCommand                    System.Management.Automation.InvocationInfo
LastCommandTime                12/02/2024 23:23:07
LastCommandResults             {"success":true,"Result":{"SomeResult"}}

Executing this command exports variables like the URL, Username & WebSession object for the authenticated session from IdentityCommand.DPA into your local scope, either for use in other requests outside of the module scope, or for informational purposes.

Return data also includes details such as session start time, elapsed time, last command time, as well as data for the last invoked command and the results of the previous command.

The commands currently available in the IdentityCommand.DPA module are listed here:

• Requires Powershell Core (recommended), or Windows PowerShell (version 5.1)
• A CyberArk Identity tenant with the Dynamic Privileged Access service enabled
• An Account to Access CyberArk Identity

Users can install IdentityCommand.DPA from GitHub or the PowerShell Gallery.

Choose any of the following ways to download the module and install it:

This is the easiest and most popular way to install the module:

1. Open a PowerShell prompt

2. Run the following command:

Install-Module -Name IdentityCommand.DPA -Scope CurrentUser

The module files can be manually copied to one of your PowerShell module directories.

Use the following command to get the paths to your local PowerShell module folders:

$env:PSModulePath.split(';')

The module files must be placed in one of the listed directories, in a folder called IdentityCommand.DPA.

More: about_PSModulePath

The module files are available to download using a variety of methods:

• Download from the module from the PowerShell Gallery:
  • Run the PowerShell command Save-Module -Name IdentityCommand.DPA -Path C:\temp
  • Copy the C:\temp\IdentityCommand.DPA folder to your "Powershell Modules" directory of choice.

• Download the latest GitHub release
  • Unblock & Extract the archive
  • Rename the extracted IdentityCommand.DPA-v#.#.# folder to IdentityCommand.DPA
  • Copy the IdentityCommand.DPA folder to your "Powershell Modules" directory of choice.

• Download the main branch
  • Unblock & Extract the archive
  • Copy the IdentityCommand.DPA (\<Archive Root>\IdentityCommand.DPA-master\IdentityCommand.DPA) folder to your "Powershell Modules" directory of choice.

Validate Install:

Get-Module -ListAvailable IdentityCommand.DPA

Import the module:

Import-Module IdentityCommand.DPA

List Module Commands:

Get-Command -Module IdentityCommand.DPA

Get detailed information on specific commands:

Get-Help New-IDSession -Full

Please support continued development; consider sponsoring @pspete on GitHub Sponsors

All notable changes to this project will be documented in the Changelog

• Pete Maan - pspete

This project is licensed under the MIT License.

Any and all contributions to this project are appreciated.

See the CONTRIBUTING.md for a few more details.

IdentityCommand.DPA is neither developed nor supported by CyberArk; any official support channels offered by the vendor are not appropriate for seeking help with the IdentityCommand.DPA module.

Help and support should be sought by opening an issue.

Priority support could be considered for sponsors of @pspete, contact us to discuss options.