Skip to content

Latest commit

 

History

History
146 lines (84 loc) · 4.79 KB

README.md

File metadata and controls

146 lines (84 loc) · 4.79 KB
Raw

CredentialRetriever

Master Branch Latest Build CodeFactor Coverage PowerShell Gallery License
appveyor tests codefactor codecov psgallery license
coveralls downloads

CyberArk Central Credential Provider PowerShell Retriever

Use PowerShell to retrieve credentials from the CyberArk Central Credential Provider Web Service or a local Credential Provider SDK.

Usage

Get-CCPCredential

Supply the AppID and URL to the CyberArk Central Credential Provider Web Service.

Specify relevant parameter values needed to find the required account.

Get-CCPCredential

Get-AIMCredential

Set the path to the CLIPasswordSDK.exe utility. This value will persist, and be imported each time the CredentialRetriever module is imported.

Set-AIMConfiguration

Supply the AppID & relevant parameter values needed to find the required account.

Get-AIMCredential

ToSecureString Method

Where required for downstream consumption, easily convert returned password to a System.Security.SecureString, using the ToSecureString() Method.

ToSecureString Method

ToCredential Method

Use the ToCredential() Method to convert the returned Username/Password to a PSCredential Object.

ToCredential Method

Installation

Prerequisites

  • Requires Powershell v5.1 (minimum)
  • CyberArk Central Credential Provider Web Service, And\Or
  • CyberArk Credential Provider

Install Options

This repository contains a folder named CredentialRetriever.

The folder needs to be copied to one of your PowerShell Module Directories.

Use one of the following methods:

Option 1: Install from PowerShell Gallery

PowerShell 5.0 or above & Administrator rights are required.

To download the module from the PowerShell Gallery,
from an elevated PowerShell prompt, run:

Install-Module -Name CredentialRetriever -Scope CurrentUser

Option 2: Manual Install

Find your PowerShell Module Paths with the following command:

$env:PSModulePath.split(';')

Download the master branch

Extract the archive

Copy the CredentialRetriever folder to your "Powershell Modules" directory of choice.

Verification

Validate Module Exists on your local machine:

Get-Module -ListAvailable CredentialRetriever

Import the module:

Import-Module CredentialRetriever

Get detailed information on commands:

Get-Help Get-CCPCredential -Full

Changelog

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

Author

License

This project is licensed under the MIT License.

Contributing

Any and all contributions to this project are appreciated.

See the CONTRIBUTING.md for a few more details.