external help file: Module Name: online version: https://psraw.readthedocs.io/en/latest/PrivateFunctions/Request-RedditOAuthTokenPassword schema: 2.0.0

Request-RedditOAuthTokenPassword

SYNOPSIS

Requests a Password OAuth Access Token from reddit.

SYNTAX

Request-RedditOAuthTokenPassword [-Application] <RedditApplication> [[-AuthBaseUrl] <String>]
 [<CommonParameters>]

DESCRIPTION

Requests an OAuth Access Token from Reddit using the password grant flow. The password grant flow can only be performed for Script applications. This allows an application developer to obtain an OAuth Access Token under their own user context using their Reddit Username, Reddit passwords, Application Client ID, and Application Client Secret. For more information on this grant method see the Password parameter description for Request-RedditOAuthToken.

This function is essentially a convenience wrapper for Invoke-WebRequest and returns a RedditOAuthResponse that results from the Auth Token Request.

This function is not intended for direct usage by the module consumer and is not exported by the module. Documentation is provided for developers and contributors.

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

$Result = Request-RedditOAuthTokenPassword -Application $Application

This example demonstrates how Request-RedditOAuthToken calls Request-RedditOAuthTokenPassword to request an OAuth Access Token.

PARAMETERS

-Application

The RedditApplication Object for the Application that will be used to request the OAuth Access Token. Only Script applications will be allowed.

Type: RedditApplication
Parameter Sets: (All)
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-AuthBaseUrl

Optional parameter for the Base URL to request the Access OAuth Token from. The default is to use [RedditOAuthToken]::AuthBaseURL

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).