VarbiAPI

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Changelog
• Roadmap
• License
• Acknowledgements

About The Project

This module was created to make user provisioning to the Varbi system as easy as possible. It was also created in a way that other organizations can utilize it.

Built With

• Powershell
• VSCode
• Varbi API documentation

Getting Started

There are a few steps you need to complete before you can start using the cmdlets in this module. Please make sure you've followed each one.

Prerequisites

• Powershell 5.1
• Licensed version of Varbi to get access to the API.
• API key and a service account provided by the vendor.

Installation

1. Start a powershell session with the account that will be running the tasks. This is because when doing steps 4 & 5, the credential files will only be readable by the very same account that created them.
2. Install-Module -Name VarbiAPI
3. Import-Module -Name VarbiAPI. You will get a warning saying that there is no settings file present, but let's skip this for now.
4. New-Secret See New-Secret.md for examples.
5. Run Initialize-SettingsFile. See Initialize-SettingsFile.md for examples.
6. Finally import the module again Import-Module VarbiAPI -Force. And you should be good to go!

Changelog

VarbiAPI is currently only maintained by me. I will try to add as many features as possible.

• 2022.03.03 - Version: 0.0.1.4

  • New public cmdlets:
    • Clear-VarbiUser
  • New private functions:
    • Get-SyncData
      • Handles data sent from Sync-VarbiFromADGroup and returns a structured object with information on what needs to be done regarding the synchronization.
    • Write-CMTLog
      • Writes logs from Sync-VarbiFromADGroup in a format that CMTrace reads really well.
    • Write-StartEndLog
      • Writes starting and ending point in the log file
  • Various edits to Sync-VarbiFromADGroup, Update-VarbiUser and Format-APICall

• 2022.02.28 - Version: 0.0.1.3

  • New public cmdlets:
    • Sync-VarbiFromADGroup
  • New private functions:
    • Compare-Object
      • A proxy function for the built-in Compare-Object cmdlet, created by DBremen
  • Various fixes in cmdlets and functions.

• 2022.02.22 - Version: 0.0.1.2

  • New public cmdlets:
    • Update-VarbiUser
    • Disable-VarbiUser
    • Enable-VarbiUser
  • New private functions:
    • ConvertFrom-ADObject
      • Converts an AD user object into json prepared object with all the right properties.
  • New nested module:
    • SecretClixml
      • Used to encrypt and store the API key aswell as retrieving it.

• 2022.02.17 - Version: 0.0.1.1

  • New public cmdlets:
    • Initialize-SettingsFile
  • New private functions:
    • Get-FilePath
      • Used in conjunction with Initialize-SettingsFile to prompt user for storing settings file and loading credential file.
    • Format-UsedParameter
      • Takes data and formats it accordingly
    • Format-APICall
      • Formats all properties into a splatted object to be used by Invoke-VarbiAPI

• 2022.02.07 - Version: 0.0.1.0

  • Created this repository, first commit.
  • Available but not entirely finished public cmdlets:
    • Get-VarbiUser
    • New-VarbiUser
  • Kind of finished private functions:
    • Invoke-VarbiAPI
      • Sort of the heart of it all. Every public function calls this one with it's formatted request string.
    • Get-EncryptedAPIKey
      • Retrieves the encrypted API key. Needs to be run under the same context as when it was stored.

Usage

See cmdlet docs

Roadmap

• Adding compability for working more schemas, such as Permissions, Organizations and Privileges
• Improve error message handling

Acknowledgements

Varbi for great API documentation.