Skip to content

Latest commit

 

History

History
112 lines (84 loc) · 2.46 KB

New-WattTimeAccount.md

File metadata and controls

112 lines (84 loc) · 2.46 KB
external help file Module Name online version schema
PSWattTime-help.xml
PSWattTime
2.0.0

New-WattTimeAccount

SYNOPSIS

Create a new WattTime API account

SYNTAX

New-WattTimeAccount [-Username] <String> [-Password] <String> [-Email] <String> [-Organization] <String>
 [<CommonParameters>]

DESCRIPTION

Creates a new WattTime API account with the specified username, password, email and organization on watttime.org

EXAMPLES

EXAMPLE 1

New-WattTimeAccount -Username 'username' -Password 'password' -Email 'email' -Organization 'organization'

PARAMETERS

-Username

The username for the new account

Type: String
Parameter Sets: (All)
Aliases:

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

-Password

The password for the new account

Type: String
Parameter Sets: (All)
Aliases:

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

-Email

The email address for the new account

Type: String
Parameter Sets: (All)
Aliases:

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

-Organization

The organization for the new account

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
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

OUTPUTS

System.Management.Automation.PSObject containing the following properties:

- user: The username for the new account

- ok: The response for user creation

NOTES

You can use an email address only once at WattTime. Registering multiple accounts will fail with an error.

RELATED LINKS

https://github.com/cloudyspells/PSWattTime/blob/main/docs/New-WattTimeAccount.md

https://www.watttime.org/api-documentation/#register-new-user