Code Monkey home page Code Monkey logo

credentialretriever's Introduction

CredentialRetriever

Build status AppVeyor tests Coverage Status PowerShell Gallery license

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 v3 (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.

credentialretriever's People

Contributors

pspete avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.