Get-DSUser

Synopsis

Get one or more users

Syntax

GetPage (Default)

Get-DSUser [-PageNumber <int>] [-PageSize <int>] [-AsLegacyResponse] [<CommonParameters>]

GetAll

Get-DSUser -All [-AsLegacyResponse] [<CommonParameters>]

GetByID

Get-DSUser -UserID <guid> [-AsLegacyResponse] [<CommonParameters>]

Description

Get a single user, a page of users, or all users.

Examples

Example 1

PS C:\> Get-DSUser -All

Get all the users

Example 2

PS C:\> Get-DSUser -UserID $userID

Get a specific user

Example 3

PS C:\> Get-DSUser -PageNumber 1 -PageSize 10

Get the first page containing 10 users

Parameters

-All

All users will be fetched.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: GetAll
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-AsLegacyResponse

In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-PageNumber

Specify the page of users fetched. First page is fetched by default.

Type: System.Int32
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: GetPage
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-PageSize

Number of users per page. 10 users per page by default.

Type: System.Int32
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: GetPage
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-UserID

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases:
- CandidUserID
ParameterSets:
- Name: GetByID
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Notes

For more information, type "Get-Help Get-DSUser -detailed". For technical information, type "Get-Help Get-DSUser -full".