fletcherg / litmos-client

PowerShell Litmos API client

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

litmos-client

Very basic PowerShell client implementation for Litmos LMS API.

https://support.litmos.com/hc/en-us/articles/227734667-Overview-Developer-API

Only some functions have been implemented, and I got a bit lazy ๐Ÿ˜ฐ. But hopefully this is of use to someone to build on ๐Ÿ˜‰ โค๏ธ

Getting Started

You will need a Litmos account setup, and an API key

https://support.litmos.com/hc/en-us/articles/227734847-Retrieving-Your-API-Key

The following example will let you login:


$tenantName = "sandbox"
$apiKey = "943f6ae4-c986-44ec-b370-7570c8aa2c79"
$server = "api.litmos.com.au"

# Load the module into memory
iwr 'https://raw.githubusercontent.com/gfletche/litmos-client/master/litmos-client.psm1' | iex

# make connection to Litmos
Connect-Litmos -server $server -apiKey $apiKey -tenantName $tenantName

Get-LitmosUser -All

# Disconnect from Litmos
Disconnect-Litmos

Functions

See below for a list of available commands.

Connect-Litmos

Get-LitmosTeam

Get-LitmosTeamMember

Get-LitmosUser

New-LitmosTeam

New-LitmosUser

Remove-LitmosUser

Remove-LitmosTeam

Remove-LitmosTeamMember

Update-LitmosUser

Disconnect-Litmos

To Do

  • Remove some hacky shortcuts... sorry.. ๐Ÿ˜“ ๐Ÿ˜”
  • Add support for more litmos functions

About

PowerShell Litmos API client

License:MIT License


Languages

Language:PowerShell 100.0%