Get-Credential

  • Référence
Module:
Microsoft.PowerShell.Security

Obtient un objet d'informations d'identification basé sur un nom d'utilisateur et un mot de passe.

Syntax

Get-Credential
   [[-Credential] <PSCredential>]
   [<CommonParameters>]
Get-Credential
   [-Message <String>]
   [[-UserName] <String>]
   [-Title <String>]
   [<CommonParameters>]

Description

L’applet Get-Credential de commande crée un objet d’informations d’identification pour un nom d’utilisateur et un mot de passe spécifiés. Vous pouvez utiliser l'objet d'informations d'identification dans les opérations de sécurité.

L’applet Get-Credential de commande invite l’utilisateur à entrer un mot de passe ou un nom d’utilisateur et un mot de passe. Vous pouvez utiliser le paramètre Message pour spécifier un message personnalisé pour l’invite.

Dans Windows PowerShell 5.1 et versions antérieures, Windows présente une boîte de dialogue pour demander un nom d’utilisateur et un mot de passe. Dans PowerShell 6.0 et versions ultérieures, l’invite est présentée dans la console pour toutes les plateformes.

Exemples

Exemple 1

$c = Get-Credential

Cette commande obtient un objet d’informations d’identification et l’enregistre dans la $c variable.

Lorsque vous entrez la commande, vous êtes invité à entrer un nom d’utilisateur et un mot de passe. Lorsque vous entrez les informations demandées, l’applet de commande crée un objet PSCredential représentant les informations d’identification de l’utilisateur et l’enregistre dans la $c variable.

Vous pouvez utiliser l’objet comme entrée pour les applets de commande qui demandent l’authentification utilisateur, telles que celles avec un paramètre Credential . Toutefois, certains fournisseurs installés avec PowerShell ne prennent pas en charge le paramètre Credential .

Exemple 2

$c = Get-Credential -credential User01
$c.Username
User01

Cet exemple crée une information d'identification qui inclut un nom d'utilisateur sans nom de domaine.

La première commande obtient des informations d’identification avec le nom d’utilisateur User01 et la stocke dans la $c variable. La deuxième commande affiche la valeur de la propriété Username de l’objet d’informations d’identification résultant.

Exemple 3

$Credential = $host.ui.PromptForCredential("Need credentials", "Please enter your user name and password.", "", "NetBiosUserName")

Cette commande utilise la méthode PromptForCredential pour inviter l’utilisateur à entrer son nom d’utilisateur et son mot de passe. La commande enregistre les informations d’identification obtenues dans la $Credential variable.

La méthode PromptForCredential est une alternative à l’utilisation de l’applet de Get-Credential commande. Lorsque vous utilisez PromptForCredential, vous pouvez spécifier les légende, messages et nom d’utilisateur qui apparaissent dans l’invite.

Pour plus d’informations, consultez la documentation PromptForCredential dans le Kit de développement logiciel (SDK).

Exemple 4

Cet exemple montre comment créer un objet d’informations d’identification identique à l’objet qui Get-Credential retourne sans inviter l’utilisateur. Cette méthode nécessite un mot de passe en texte brut, ce qui peut violer les normes de sécurité dans certaines entreprises.

$User = "Domain01\User01"
$PWord = ConvertTo-SecureString -String "P@sSwOrd" -AsPlainText -Force
$Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $User, $PWord

La première commande enregistre le nom du compte d’utilisateur dans le $User paramètre. La valeur doit avoir le format « Domain\User » ou « ComputerName\User ».

La deuxième commande utilise l’applet ConvertTo-SecureString de commande pour créer une chaîne sécurisée à partir d’un mot de passe de texte brut. La commande utilise le paramètre AsPlainText pour indiquer que la chaîne est un texte brut et le paramètre Force pour confirmer que vous comprenez les risques liés à l’utilisation de texte brut.

La troisième commande utilise l’applet New-Object de commande pour créer un objet PSCredential à partir des valeurs dans les variables et $PWord les $User valeurs.

Exemple 5

Get-Credential -Message "Credential are required for access to the \\Server1\Scripts file share." -User Server01\PowerUser

PowerShell Credential Request
Credential are required for access to the \\Server1\Scripts file share.
Password for user Server01\PowerUser:

Cette commande utilise les paramètres Message et UserName de l’applet Get-Credential de commande. Ce format de commande est conçu pour les fonctions et les scripts partagés. Dans ce cas, le message indique à l'utilisateur pourquoi les informations d'identification sont nécessaires tout en l'assurant implicitement que la demande est légitime.

Exemple 6

Invoke-Command -ComputerName Server01 {Get-Credential Domain01\User02}

PowerShell Credential Request : PowerShell Credential Request
Warning: This credential is being requested by a script or application on the SERVER01 remote computer.
Enter your credentials only if you trust the remote computer and the application or script requesting it.

Enter your credentials.
Password for user Domain01\User02: ***************

PSComputerName     : Server01
RunspaceId         : 422bdf52-9886-4ada-ab2f-130497c6777f
PSShowComputerName : True
UserName           : Domain01\User01
Password           : System.Security.SecureString

Cette commande obtient des informations d'identification de l'ordinateur distant Server01. La commande utilise l’applet Invoke-Command de commande pour exécuter une Get-Credential commande sur l’ordinateur distant. La sortie affiche le message de sécurité à distance inclus Get-Credential dans l’invite d’authentification.

Paramètres

-Credential

Spécifie un nom d’utilisateur pour les informations d’identification, telles que User01 ou Domain01\User01. Le nom du paramètre, est -Credentialfacultatif.

Lorsque vous envoyez la commande et spécifiez un nom d’utilisateur, vous êtes invité à entrer un mot de passe. Si vous omettez ce paramètre, vous êtes invité à entrer un nom d’utilisateur et un mot de passe.

À compter de PowerShell 3.0, si vous entrez un nom d’utilisateur sans domaine, Get-Credential n’insère plus de barre oblique inverse avant le nom.

Les informations d’identification sont stockées dans un objet PSCredential et le mot de passe est stocké en tant que SecureString.

Remarque

Pour plus d’informations sur la protection des données SecureString , consultez Comment secure is SecureString ?.

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

-Message

Spécifie un message qui s'affiche dans l'invite d'authentification. Ce paramètre est conçu pour une utilisation dans une fonction ou un script. Vous pouvez utiliser le message pour expliquer à l'utilisateur pourquoi vous demandez des informations d'identification et comment elles seront utilisées.

Ce paramètre a été introduit dans PowerShell 3.0.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Title

Définit le texte de la ligne de titre de l’invite d’authentification dans la console.

Ce paramètre a été introduit dans PowerShell 6.0.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserName

Spécifie un nom d'utilisateur. L'invite d'authentification demande un mot de passe pour le nom d'utilisateur. Par défaut, le nom d'utilisateur est vide et l'invite d'authentification demande un nom d'utilisateur et un mot de passe.

Ce paramètre a été introduit dans PowerShell 3.0.

Type:String
Position:1
Default value:None (blank)
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entrées

None

Vous ne pouvez pas diriger les objets vers cette applet de commande.

Sorties

PSCredential

Cette applet de commande retourne un objet d’informations d’identification.

Notes

Vous pouvez utiliser l’objet PSCredential qui Get-Credential crée dans les applets de commande qui demandent l’authentification de l’utilisateur, comme celles avec un paramètre Credential .

Le paramètre Credential n’est pas pris en charge par tous les fournisseurs installés avec PowerShell. À compter de PowerShell 3.0, il est pris en charge sur les applets de commande sélectionnées, telles que les Get-Content applets de commande et New-PSDrive les applets de commande.