Get-IDUser
SYNOPSIS
Fetch details of cloud directory users
SYNTAX
GetUsers (Default)
Get-IDUser [<CommonParameters>]
GetUser
Get-IDUser -ID <String> [<CommonParameters>]
GetUserByName
Get-IDUser -username <String> [<CommonParameters>]
GetUserAttributes
Get-IDUser [-CurrentUser] [<CommonParameters>]
GetTechSupportUser
Get-IDUser [-TechSupportUser] [<CommonParameters>]
GetUserSettings
Get-IDUser -ID <String> -SettingType <String> [<CommonParameters>]
DESCRIPTION
By default, returns details of all existing users in the cloud directory.
Specify `id` or `username` parameter to to fetch the details of a specific existing user in the cloud directory.
Specify `id` together with `SettingType` to fetch a specific setting for a specific user (via a different underlying API to the other parameter sets).
EXAMPLES
Example 1
PS C:\> Get-IDUser
Return all users
Example 2
PS C:\> Get-IDUser -id 1234-abcd-5678-efgh
Return user with matching id
Example 3
PS C:\> Get-IDUser -username someuser@somedomain.com
Return user with matching username
Example 4
PS C:\> Get-IDUser -CurrentUser
Return details of current authenticated user
Example 5
PS C:\> Get-IDUser -TechSupportUser
Return details of current authenticated user
PARAMETERS
-username
The username of the user to get details of
Type: String
Parameter Sets: GetUserByName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ID
The id of the user to get details of.
Type: String
Parameter Sets: GetUser
Aliases: Uuid
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ID
The id of the user to fetch a setting for, used together with -SettingType. Not accepted from the pipeline in this parameter set, to avoid ambiguous binding when an input object also has a SettingType property.
Type: String
Parameter Sets: GetUserSettings
Aliases: Uuid
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CurrentUser
Specify to return details of authenticated user
Type: SwitchParameter
Parameter Sets: GetUserAttributes
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-TechSupportUser
Specify to return details of the Tech Support User
Type: SwitchParameter
Parameter Sets: GetTechSupportUser
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-SettingType
The type of setting to fetch. Used together with -ID.
Type: String
Parameter Sets: GetUserSettings
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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.