Skip to content

Latest commit

 

History

History
125 lines (91 loc) · 5.34 KB

README.md

File metadata and controls

125 lines (91 loc) · 5.34 KB

License Documentation PowerShell Gallery PowerShell Gallery Minimum Supported PowerShell Version Minimum Supported PowerShell Core Version Wiki Codacy Badge

PSAuth

PowerShell module containing functions to make HTTP requests including OAuth 1.0 authentication.

Module Build Status

Branch AzurePipelines CI AppVeyor CI Travis CI Code Coverage
dev ap-image-dev av-image-dev tv-image-dev cc-image-dev
master ap-image-master av-image-master tv-image-master cc-image-master

Table of Contents

Requirements

This module requires the following:

  • Windows PowerShell 5.1 and above or
  • PowerShell Core 6.x on:
    • Windows
    • Linux
    • macOS

Installation

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.

Compatibility and Testing

This PowerShell module is automatically tested and validated to run on the following systems:

  • Windows Server (using Windows PowerShell 5.1):
  • Linux (using PowerShell Core 6.x):
  • macOS (using PowerShell Core 6.x):

This module should function correctly on other systems and configurations but is not automatically tested with them in every change.

Automated Integration Tests

This project does not currently contain any automated integration tests.

Cmdlets

  • 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.

Known Issues

None.

Recommendations

None.

Examples

For further examples, please see module help for individual cmdlets.

Links