Skip to content

Latest commit

 

History

History
143 lines (106 loc) · 2.54 KB

Get-KshUser.md

File metadata and controls

143 lines (106 loc) · 2.54 KB
external help file Module Name online version schema
SPClientCore.dll-Help.xml
SPClientCore
2.0.0

Get-KshUser

SYNOPSIS

Retrieves one or more users.

SYNTAX

ParamSet1

Get-KshUser [-Identity] <User> [<CommonParameters>]

ParamSet2

Get-KshUser [-UserId] <Int32> [<CommonParameters>]

ParamSet3

Get-KshUser [-UserName] <String> [<CommonParameters>]

ParamSet4

Get-KshUser [-NoEnumerate] [<CommonParameters>]

DESCRIPTION

The Get-KshUser cmdlet retrieves users of the current site.

EXAMPLES

Example 1

PS C:\> Get-KshUser -UserId 1

Retrieves a user by user ID.

Example 2

PS C:\> Get-KshUser -UserName 'i:0#.f|membership|[email protected]'

Retrieves a user by user login name.

Example 3

PS C:\> Get-KshUser -UserName '[email protected]'

Retrieves a user by user e-mail address.

Example 4

PS C:\> Get-KshUser

Retrieves all users of the current site.

PARAMETERS

-Identity

Specifies the user.

Type: User
Parameter Sets: ParamSet1
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-NoEnumerate

If specified, suppresses to enumerate objects.

Type: SwitchParameter
Parameter Sets: ParamSet4
Aliases:

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

-UserId

Specifies the user ID.

Type: Int32
Parameter Sets: ParamSet2
Aliases:

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

-UserName

Specifies the user login name or e-mail address.

Type: String
Parameter Sets: ParamSet3
Aliases:

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

Karamem0.SharePoint.PowerShell.Models.V1.User

OUTPUTS

Karamem0.SharePoint.PowerShell.Models.V1.User

NOTES

RELATED LINKS