Skip to content

Fixes #4985 Updated Credential parameter description with SecureString information (part 4) #5038

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 31, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions reference/5.1/Microsoft.PowerShell.Security/Get-Credential.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,15 +191,21 @@ the remote security message that **Get-Credential** includes in the authenticati

### -Credential

Specifies a user name for the credential, such as "User01" or "Domain01\User01".
The parameter name ("Credential") is optional.
Specifies a user name for the credential, such as **User01** or **Domain01\User01**. The parameter
name, `-Credential`, is optional.

When you submit the command, you will be prompted for a password.
When you submit the command and specify a user name, you're prompted for a password. If you omit
this parameter, you're prompted for a user name and a password.

Starting in Windows PowerShell 3.0, if you enter a user name without a domain, Get-Credential no
Starting in Windows PowerShell 3.0, if you enter a user name without a domain, `Get-Credential` no
longer inserts a backslash before the name.

If you omit this parameter, you will be prompted for a user name and a password.
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

```yaml
Type: PSCredential
Expand Down
13 changes: 10 additions & 3 deletions reference/5.1/Microsoft.PowerShell.Utility/Invoke-RestMethod.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,10 +220,17 @@ Accept wildcard characters: False

### -Credential

Specifies a user account that has permission to send the request.
The default is the current user.
Specifies a user account that has permission to send the request. The default is the current user.

Type a user name, such as "User01" or "Domain01\User01", or enter a **PSCredential** object, such as one generated by the `Get-Credential` cmdlet.
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
generated by the `Get-Credential` cmdlet.

Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

```yaml
Type: PSCredential
Expand Down
15 changes: 11 additions & 4 deletions reference/5.1/Microsoft.PowerShell.Utility/Invoke-WebRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,11 +250,18 @@ Accept wildcard characters: False

### -Credential

Specifies a user account that has permission to send the request.
The default is the current user.
Specifies a user account that has permission to send the request. The default is the current user.

Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
generated by the `Get-Credential` cmdlet.

Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

Type a user name, such as `User01` or `Domain01\User01`, or enter a **PSCredential** object,
such as one generated by the `Get-Credential` cmdlet.

```yaml
Type: PSCredential
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,13 @@ user.
Type a user name, such as **User01** or **Domain01\User01**. Or, enter a **PSCredential** object,
such as one from the `Get-Credential` cmdlet.

Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

```yaml
Type: PSCredential
Parameter Sets: (All)
Expand Down
16 changes: 11 additions & 5 deletions reference/6/Microsoft.PowerShell.Security/Get-Credential.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,15 +190,21 @@ the remote security message that **Get-Credential** includes in the authenticati

### -Credential

Specifies a user name for the credential, such as "User01" or "Domain01\User01".
The parameter name ("Credential") is optional.
Specifies a user name for the credential, such as **User01** or **Domain01\User01**. The parameter
name, `-Credential`, is optional.

When you submit the command, you will be prompted for a password.
When you submit the command and specify a user name, you're prompted for a password. If you omit
this parameter, you're prompted for a user name and a password.

Starting in Windows PowerShell 3.0, if you enter a user name without a domain, Get-Credential no
Starting in Windows PowerShell 3.0, if you enter a user name without a domain, `Get-Credential` no
longer inserts a backslash before the name.

If you omit this parameter, you will be prompted for a user name and a password.
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

```yaml
Type: PSCredential
Expand Down
25 changes: 17 additions & 8 deletions reference/6/Microsoft.PowerShell.Utility/Invoke-RestMethod.md
Original file line number Diff line number Diff line change
Expand Up @@ -342,13 +342,22 @@ Accept wildcard characters: False

### -Credential

Specifies a user account that has permission to send the request.
The default is the current user.
Specifies a user account that has permission to send the request. The default is the current user.

Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
generated by the `Get-Credential` cmdlet.

Type a user name, such as "User01", "Domain01\User01", "[email protected]", or enter a `PSCredential` object, such as one generated by the `Get-Credential` cmdlet.
**Credential** can be used alone or in conjunction with certain **Authentication** parameter
options. When used alone, it will only supply credentials to the remote server if the remote server
sends an authentication challenge request. When used with **Authentication** options, the
credentials will be explicitly sent.

**-Credential** can be used alone or in conjunction with certain **-Authentication** options. When used alone, it will only supply credentials to the remote server if the remote server
sends an authentication challenge request. When used with **-Authentication** options, the credentials will be explicitly sent.
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

```yaml
Type: PSCredential
Expand All @@ -357,7 +366,7 @@ Aliases:

Required: False
Position: Named
Default value: None
Default value: Current user
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down Expand Up @@ -408,10 +417,10 @@ Accept wildcard characters: False

### -FollowRelLink

Indicates the cmdlet should follow relation links.
Indicates the cmdlet should follow relation links.

Some REST APIs support pagination via Relation Links per [RFC5988](https://tools.ietf.org/html/rfc5988#page-6).
Instead of parsing the header to get the URL for the next page, you can have the cmdlet do this for you.
Instead of parsing the header to get the URL for the next page, you can have the cmdlet do this for you.
To set how many times to follow relation links, use the **MaximumFollowRelLink** parameter.

When using this switch, the cmdlet returns a collection of pages of results.
Expand Down
19 changes: 13 additions & 6 deletions reference/6/Microsoft.PowerShell.Utility/Invoke-WebRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -426,13 +426,20 @@ Accept wildcard characters: False

Specifies a user account that has permission to send the request. The default is the current user.

Type a user name, such as "User01", "Domain01\User01", "[email protected]", or enter a
`PSCredential` object, such as one generated by the `Get-Credential` cmdlet.
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
generated by the `Get-Credential` cmdlet.

**Credential** can be used alone or in conjunction with certain **Authentication** parameter
options. When used alone, it only supplies credentials to the remote server if the remote server
sends an authentication challenge request. When used with **Authentication** options, the
credentials are explicitly sent.

**Credential** can be used alone or in conjunction with certain **Authentication** options. When
used alone, it only supplies credentials to the remote server if the remote server sends an
authentication challenge request. When used with **Authentication** options, the credentials are
explicitly sent.
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

```yaml
Type: PSCredential
Expand Down
7 changes: 7 additions & 0 deletions reference/6/Microsoft.PowerShell.Utility/Send-MailMessage.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,13 @@ user.
Type a user name, such as **User01** or **Domain01\User01**. Or, enter a **PSCredential** object,
such as one from the `Get-Credential` cmdlet.

Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

```yaml
Type: PSCredential
Parameter Sets: (All)
Expand Down
16 changes: 11 additions & 5 deletions reference/7/Microsoft.PowerShell.Security/Get-Credential.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,15 +190,21 @@ the remote security message that **Get-Credential** includes in the authenticati

### -Credential

Specifies a user name for the credential, such as "User01" or "Domain01\User01".
The parameter name ("Credential") is optional.
Specifies a user name for the credential, such as **User01** or **Domain01\User01**. The parameter
name, `-Credential`, is optional.

When you submit the command, you will be prompted for a password.
When you submit the command and specify a user name, you're prompted for a password. If you omit
this parameter, you're prompted for a user name and a password.

Starting in Windows PowerShell 3.0, if you enter a user name without a domain, Get-Credential no
Starting in Windows PowerShell 3.0, if you enter a user name without a domain, `Get-Credential` no
longer inserts a backslash before the name.

If you omit this parameter, you will be prompted for a user name and a password.
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

```yaml
Type: PSCredential
Expand Down
21 changes: 15 additions & 6 deletions reference/7/Microsoft.PowerShell.Utility/Invoke-RestMethod.md
Original file line number Diff line number Diff line change
Expand Up @@ -342,13 +342,22 @@ Accept wildcard characters: False

### -Credential

Specifies a user account that has permission to send the request.
The default is the current user.
Specifies a user account that has permission to send the request. The default is the current user.

Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
generated by the `Get-Credential` cmdlet.

Type a user name, such as "User01", "Domain01\User01", "[email protected]", or enter a `PSCredential` object, such as one generated by the `Get-Credential` cmdlet.
**Credential** can be used alone or in conjunction with certain **Authentication** parameter
options. When used alone, it will only supply credentials to the remote server if the remote server
sends an authentication challenge request. When used with **Authentication** options, the
credentials will be explicitly sent.

**-Credential** can be used alone or in conjunction with certain **-Authentication** options. When used alone, it will only supply credentials to the remote server if the remote server
sends an authentication challenge request. When used with **-Authentication** options, the credentials will be explicitly sent.
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

```yaml
Type: PSCredential
Expand All @@ -357,7 +366,7 @@ Aliases:

Required: False
Position: Named
Default value: None
Default value: Current user
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
19 changes: 13 additions & 6 deletions reference/7/Microsoft.PowerShell.Utility/Invoke-WebRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -426,13 +426,20 @@ Accept wildcard characters: False

Specifies a user account that has permission to send the request. The default is the current user.

Type a user name, such as "User01", "Domain01\User01", "[email protected]", or enter a
`PSCredential` object, such as one generated by the `Get-Credential` cmdlet.
Type a user name, such as **User01** or **Domain01\User01**, or enter a **PSCredential** object
generated by the `Get-Credential` cmdlet.

**Credential** can be used alone or in conjunction with certain **Authentication** parameter
options. When used alone, it only supplies credentials to the remote server if the remote server
sends an authentication challenge request. When used with **Authentication** options, the
credentials are explicitly sent.

**Credential** can be used alone or in conjunction with certain **Authentication** options. When
used alone, it only supplies credentials to the remote server if the remote server sends an
authentication challenge request. When used with **Authentication** options, the credentials are
explicitly sent.
Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

```yaml
Type: PSCredential
Expand Down
7 changes: 7 additions & 0 deletions reference/7/Microsoft.PowerShell.Utility/Send-MailMessage.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,13 @@ user.
Type a user name, such as **User01** or **Domain01\User01**. Or, enter a **PSCredential** object,
such as one from the `Get-Credential` cmdlet.

Credentials are stored in a [PSCredential](/dotnet/api/system.management.automation.pscredential)
object and the password is stored as a [SecureString](/dotnet/api/system.security.securestring).

> [!NOTE]
> For more information about **SecureString** data protection, see
> [How secure is SecureString?](/dotnet/api/system.security.securestring#how-secure-is-securestring).

```yaml
Type: PSCredential
Parameter Sets: (All)
Expand Down