{"id":21071824,"url":"https://github.com/devblackops/passwordstate","last_synced_at":"2025-05-16T05:32:01.135Z","repository":{"id":32119783,"uuid":"35692262","full_name":"devblackops/PasswordState","owner":"devblackops","description":"PowerShell module for interacting with ClickStudio's PasswordState password management application","archived":false,"fork":false,"pushed_at":"2020-01-02T21:52:02.000Z","size":192,"stargazers_count":41,"open_issues_count":13,"forks_count":14,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-03T20:51:16.879Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devblackops.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"devblackops","patreon":"devblackops"}},"created_at":"2015-05-15T19:20:58.000Z","updated_at":"2024-12-03T21:07:23.000Z","dependencies_parsed_at":"2022-09-22T23:50:44.488Z","dependency_job_id":null,"html_url":"https://github.com/devblackops/PasswordState","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devblackops%2FPasswordState","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devblackops%2FPasswordState/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devblackops%2FPasswordState/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devblackops%2FPasswordState/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devblackops","download_url":"https://codeload.github.com/devblackops/PasswordState/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254474441,"owners_count":22077279,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T18:54:20.598Z","updated_at":"2025-05-16T05:32:00.667Z","avatar_url":"https://github.com/devblackops.png","language":"PowerShell","funding_links":["https://github.com/sponsors/devblackops","https://patreon.com/devblackops"],"categories":[],"sub_categories":[],"readme":"[![Build status](https://ci.appveyor.com/api/projects/status/1019ek26bd5x2op2?svg=true)](https://ci.appveyor.com/project/devblackops/passwordstate)\n\n# PasswordState\n\nPasswordstate is a PowerShell module used to interface with \nClickStudio's [PasswordState](http://www.clickstudios.com.au/) application via the REST API.\n\nThis module supports creating, retrieving, and updating \nPasswordState entries using simple PowerShell cmdlets that \nyou can integrate into your existing processes.\n\n# Getting Started\nYou start off by running `Initialize-PasswordStateRepository`, which will initialize some base variables used in the PasswordState PowerShell module. It takes 2 parameters: -APIEndpoint is the URL to where your current PasswordState installation resides, and the -CredentialRepository is where you can store \"Credentials\" or API keys in this case.\nIf you do not specify -CredentialRepository it will be created under your `%UserProfile%` folder.\n\nThen you want to store some \"credentials\" on disk (Not really credentials, but API keys, PowerShell credential objects are used as a method of storing credentials in a secure way)\n\nFirst you create a credential object using PowerShells `Get-Credential` cmdlet. You will be prompted to input a username/password, in username put in the name you want to call the credential file (Usually something that refers to, what the actual API key is giving you access to, a password list for instance), and in the password field enter your APIkey. If you do not specify a location, the credentials will be stored in the location you specified when you ran `Initialize-PasswordStateRepository`\n\n\n   ```powershell   \n   $Initialize-PasswordStateRepository -ApiEndpoint 'https://passwordstate.local/api' -CredentialRepository 'C:\\PasswordStateCreds'\n   $Cred = Get-Credential\n   Export-PasswordStateApiKey -ApiKey $cred\n   ```  \n\nLets say you entered \"ADUserList\" as Username and \"52e7c9d84hb7fa33f6b123dac823e956\" as password, this will result in a file called  ADUserList.cred under the directory C:\\PasswordStateCreds\n\nIf you at a later time want to use that credential you just call: `Import-PasswordStateApiKey`\n\n\n```powershell\n$ADUserListCred = Import-PasswordStateApiKey -Name 'ADUserList'\n```\nNow you can use that credential object (API key) to connect to PasswordState\nIn the below example, the API key is read from the $ADUserListCred variable, and URL to PasswordState is read from the URL you typed in when you ran `Initialize-PasswordStateRepository`\n```powershell\nGet-PasswordStateListPasswords -ApiKey $ADUserListCred -PasswordListId 42\n```\n\n\n# Examples\n\n - Initialize-PasswordStateRepository\n\n\t```powershell\n\tInitialize-PasswordStateRepository -ApiEndpoint 'https://passwordstate.local/api' -CredentialRepository 'C:\\PasswordStateCreds'\n\t```\n - Export-PasswordStateApiKey \n \n  \t```powershell\n    $Cred = Get-Credential\n    Export-PasswordStateApiKey -ApiKey $cred -Repository c:\\users\\joe\\data\\.customrepo\n\t```\n- Get-PasswordStateApiKey\n\n\t```powershell\n\tGet-PasswordStateApiKey -Name 'system' -Repository c:\\users\\joe\\data\\.customrepo\n\t```\n- Import-PasswordStateApiKey\n\n\t```powershell\n\t$cred = Import-PasswordStateApiKey -Name personal -Repository c:\\users\\joe\\data\\.customrepo\n\t```\n\n- Find-PasswordStatePassword\n\n\t```powershell\n\t$allPasswords = Get-PasswordStateAllPasswords -SystemApiKey $sysKey -Endpoint 'https://passwordstate.local'\n\t```\n- Get-PasswordStateAllLists\n\n\t```powershell\n\t$lists = Get-PasswordStateList -SystemApiKey $sysKey -Endpoint 'https://passwordstate.local'\n\t```\n- Get-PasswordStateAllPasswords\n\n\t```powershell\n\t$allPasswords = Get-PasswordStateAllPasswords -SystemApiKey $sysKey -Endpoint 'https://passwordstate.local'\n\t```\n- Get-PasswordStateList\n\n\t```powershell\n\t$lists = Get-PasswordStateList -SystemApiKey $sysKey -Endpoint 'https://passwordstate.local'\n\t```\n- Get-PasswordStateListPasswords\n\n\t```powershell\n\t$passwords = Get-PasswordStateListPasswords -ApiKey $key -PasswordListId 1234 -Endpoint 'https://passwordstate.local'\n\t```\n- Get-PasswordStatePasswordHistory\n\n\t```powershell\n\t$history = Get-PasswordStatePasswordHistory -ApiKey $key -PasswordId 1234 -Endpoint 'https://passwordstate.local'\n\t```\n- New-PasswordStatePassword\n\n\t```powershell\n\tNew-PasswordStatePassword -ApiKey $key -PasswordListId 1 -Title 'testPassword' -Username 'testPassword' -Description 'this is a test' -GeneratePassword\n\t```\n- New-PasswordStatePassword\n\n\t```powershell\n\tNew-PasswordStatePassword -ApiKey $key -PasswordListId 1 -Title \"TestDocument\" -Username \"testDoc\" -GeneratePassword -DocumentPath \"C:\\temp\\SecureDoc.txt\" -DocumentName SecureDoc.txt -DocumentDescription 'My Very Secure Document'\n\t```\n\n- New-PasswordStateRandomPassword\n\t```powershell\n\tNew-PasswordStateRandomPassword -Quantity 10 -WordPhrases $false -MinLength 20\n\t```\n\n- Set-PasswordStatePassword\n\t```powershell\n\tSet-PasswordStatePassword -ApiKey $key -PasswordId 1234 -Username 'mypassword'\n\t```\n- Set-PasswordStateDocument (On PasswordList)\n \n\t```powershell\n\t Set-PasswordStateDocument -ApiKey $key -PasswordListId 1 -DocumentPath \"C:\\temp\\Secure.txt\" -DocumentName SecureDoc.txt -DocumentDescription 'My Very Secure Document'\n\t```\n- Set-PasswordStateDocument (On Password)\n \n\t```powershell\n\t Set-PasswordStateDocument -ApiKey $key -PasswordId 4242 -DocumentPath \"C:\\temp\\Secure.txt\" -DocumentName SecureDoc.txt -DocumentDescription 'My Very Secure Document'\n\t```\n\n\t\n\t\nFor more information, see [http://devblackops.io](http://devblackops.io/powershell-module-for-clickstudios-passwordstate/)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevblackops%2Fpasswordstate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevblackops%2Fpasswordstate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevblackops%2Fpasswordstate/lists"}