Skip to content

Set-TwitterAuthentication

SYNOPSIS

Set the session credential variable with an option to save credentials to an encrypted file.

SYNTAX

Set-TwitterAuthentication [[-ApiKey] <SecureString>] [[-ApiSecret] <SecureString>] [[-AccessToken] <SecureString>] [[-AccessTokenSecret] <SecureString>] [-Persist] [<CommonParameters>]

DESCRIPTION

Set the session credential variable with an option to save credentials to an encrypted file.

The credentials are the API Key, API Key Secret, Access Token, Access Token Secret, and, if present, the bearer token for OAuth v2 endpoints.

The provided credentials are validated using the Test-TwitterAuthentication command internally.

If using the Persist switch, the encrypted credentials file will be stored in the folder $env:HOME/.BluebirdPS.

EXAMPLES

Example 1

PS > Set-TwitterAuthentication -Persist
Api Key: ****************
Api Key Secret: ****************
Access Token: ****************
Access Token Secret: ****************

Set the credentials and save to an encrypted file.

PARAMETERS

-ApiKey

The API key, also sometimes called the consumer key.

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-ApiSecret

The API secret, also sometimes called the consumer secret.

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-AccessToken

The access token for the user.

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-AccessTokenSecret

The access token secret for the user.

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-Persist

Use this switch to save the tested credentials to an encrypted credentials file located in $env:HOME/.BluebirdPS.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
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.

INPUTS

None

OUTPUTS

System.Object

NOTES

Online Version

Test-TwitterAuthentication

Import-TwitterAuthentication

Export-TwitterAuthentication

Api Reference - Authentication