PowerShell module containing functions to make HTTP requests including OAuth 1.0 authentication.
Branch | AzurePipelines CI | AppVeyor CI | Travis CI | Code Coverage |
---|---|---|---|---|
dev | ||||
master |
- Requirements
- Installation
- Compatibility and Testing
- Automated Integration Tests
- Cmdlets
- Known Issues
- Recommendations
- Examples
- Links
This module requires the following:
- Windows PowerShell 5.1 and above or
- PowerShell Core 6.x on:
- Windows
- Linux
- macOS
If Windows Management Framework 5.1 or above is installed or the PowerShell Package management module is available:
The easiest way to download and install the PSAuth module is using PowerShell Get to download it from the PowerShell Gallery:
Install-Module -Name PSAuth
If Windows Management Framework 5.1 or above is not available and the PowerShell Package management module is not available:
Unzip the file containing this Module to your c:\Program Files\WindowsPowerShell\Modules
folder.
This PowerShell module is automatically tested and validated to run on the following systems:
- Windows Server (using Windows PowerShell 5.1):
- Windows Server 2012 R2: Using AppVeyor CI.
- Windows Server 2016: Using AppVeyor CI.
- Linux (using PowerShell Core 6.x):
- Ubuntu Trusty 14.04: Using Tavis CI.
- macOS (using PowerShell Core 6.x):
- macOS 10.13: Using Tavis CI.
This module should function correctly on other systems and configurations but is not automatically tested with them in every change.
This project does not currently contain any automated integration tests.
Get-PSAuthorizationString
: Create an OAuth 1.0 Authorization string for use in an HTTP request.Invoke-PSAuthRestMethod
: Execute Invoke-RestMethod including an OAuth 1.0 authorization header.
The full details of the cmdlets contained in this module can also be found in the wiki.
None.
None.
For further examples, please see module help for individual cmdlets.