en-US/CredUICredential.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8" ?>
<helpItems xmlns="http://msh" schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CredUICredential</command:name> <command:verb>Get</command:verb> <command:noun>CredUICredential</command:noun> <maml:description> <maml:para>Gets a credential object based on a user name and password. It uses Windows native dialogs even on PowerShell 7.x, instead of terminal.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-CredUICredential cmdlet creates a credential object for a specified user name and password. You can use the credential object in security operations.</maml:para> <maml:para>Beginning in PowerShell 3.0, you can use the Message parameter to specify a customized message on the dialog box that prompts the user for their name and password.</maml:para> <maml:para>The Get-CredUICredential cmdlet prompts the user for a password or a user name and password. An authentication dialog box always appears to prompt the user; it always shows the modern (Vista+) CredUI dialog.</maml:para> <maml:para>This cmdlet aims to be a drop-in alternative to Get-Credential. Parameters and output are exactly the same, except that it always shows the modern Vista+ credential dialog.</maml:para> <maml:para>Refer to Get-Credential documentation for advanced usages.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CredUICredential</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a PSCredential object. If a value is supplied, it is returned unchanged and no dialog is shown.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-CredUICredential</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies the user name to use while creating the PSCredential. The CredUI modern dialog does not support pre-populating the user name, so this value has no effect on the dialog that is displayed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>Specifies the message that is displayed in the dialog box that prompts the user for credentials. Describe which script or function is requesting the credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specifies the caption of the dialog box that prompts the user for credentials. This can be helpful with password management tools, such as KeePass, that match a window title to a password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a PSCredential object. If a value is supplied, it is returned unchanged and no dialog is shown.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Specifies the user name to use while creating the PSCredential. The CredUI modern dialog does not support pre-populating the user name, so this value has no effect on the dialog that is displayed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>Specifies the message that is displayed in the dialog box that prompts the user for credentials. Describe which script or function is requesting the credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specifies the caption of the dialog box that prompts the user for credentials. This can be helpful with password management tools, such as KeePass, that match a window title to a password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>You cannot pipe input to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> </dev:type> <maml:description> <maml:para>A credential object containing the user name and password entered in the dialog box, or the Credential object that was passed in.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>This module is a maintained fork of the archived Get-WinCredential module by Zafer Balkan.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-CredUICredential</dev:code> <dev:remarks> <maml:para>Gets a credential object and saves it in the $creds variable.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-CredUICredential -Message "Type your credentials" -Username "test"</dev:code> <dev:remarks> <maml:para>Prompts for a credential, showing a custom message in the dialog box.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-CredUICredential -Message "Type your credentials" -Username "test" -Title "Creds"</dev:code> <dev:remarks> <maml:para>Prompts for a credential, showing a custom message and title in the dialog box.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>$creds | Get-CredUICredential</dev:code> <dev:remarks> <maml:para>Exports $creds as is.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/AlexCMarty/CredUICredential/blob/master/CredUICredential.md</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |