GetYmUser.md

Get-YmUser

Returns all users in the user's Yammer network or a specific user.

Syntax

Get-YmUser [-Id] <int>

Get-YmUser -Current

Get-YmUser -GroupId <int> [-Limit <int>] [-Reverse]

Get-YmUser -Email <String> [-Limit <int>] [-Reverse]

Get-YmUser -StartLetter <Char> [-Limit <int>] [-Reverse]

Returns

YammerShell.YammerObjects.YammerUser

Parameters

Parameter	Type	Required	Description
Id	int	true	The ID of a user to return
Current	SwitchParameter	true	Returns the currently authenticated user if set
Limit	int	false	The Maximum of returned users. Accepts values between 1 and 1000.
Reverse	SwitchParameter	false	Returns the users in reverse alphabetical order
Email	String	true	The email of one or more profiles to return
StartLetter	Char	true	The start letter of users to return

Examples

Example 1

PS:> Get-YmUser -GroupId 1234567 -Limit 7

Returns the first seven users of the group with the ID 1234567

Example 2

PS:> Get-YmUser -Email '[email protected]' -Reverse

Returns all user profiles with the email [email protected] in reverse alphabetical order