Get-ITGlueUser
SYNOPSIS
List or show all users
SYNTAX
Index (Default)
Get-ITGlueUser [-FilterID <Int64>] [-FilterName <String>] [-FilterEmail <String>] [-FilterRoleName <String>]
[-FilterSalesForceID <Int64>] [-Sort <String>] [-PageNumber <Int64>] [-PageSize <Int32>] [-AllResults]
[<CommonParameters>]
Show
Get-ITGlueUser -ID <Int64> [<CommonParameters>]
DESCRIPTION
The Get-ITGlueUser cmdlet returns a list of the users or the details of a single user in your account
This function can call the following endpoints: Index = /users
Show = /users/:id
EXAMPLES
EXAMPLE 1
Get-ITGlueUser
Returns the first 50 user results from your ITGlue account
EXAMPLE 2
Get-ITGlueUser -ID 8765309
Returns the user with the defined id
EXAMPLE 3
Get-ITGlueUser -PageNumber 2 -PageSize 10
Returns the first 10 results from the second page for users in your ITGlue account
PARAMETERS
-FilterID
Filter by user ID
Type: Int64
Parameter Sets: Index
Aliases: filter_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-FilterName
Filter by user name
Type: String
Parameter Sets: Index
Aliases: filter_name
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterEmail
Filter by user email address
Type: String
Parameter Sets: Index
Aliases: filter_email
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterRoleName
Filter by a users role
Allowed values: ‘Administrator’, ‘Manager’, ‘Editor’, ‘Creator’, ‘Lite’, ‘Read-only’
Type: String
Parameter Sets: Index
Aliases: filter_role_name
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterSalesForceID
Filter by Salesforce ID
Type: Int64
Parameter Sets: Index
Aliases: filter_salesforce_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Sort
Sort results by a defined value
Allowed values: ‘name’, ‘email’, ‘reputation’, ‘id’, ‘created_at’, ‘updated-at’, ‘-name’, ‘-email’, ‘-reputation’, ‘-id’, ‘-created_at’, ‘-updated-at’
Type: String
Parameter Sets: Index
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PageNumber
Return results starting from the defined number
Type: Int64
Parameter Sets: Index
Aliases: page_number
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-PageSize
Number of results to return per page
The maximum number of page results that can be requested is 1000
Type: Int32
Parameter Sets: Index
Aliases: page_size
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-ID
Get a user by id
Type: Int64
Parameter Sets: Show
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-AllResults
Returns all items from an endpoint
This can be used in unison with -PageSize to limit the number of sequential requests to the API
Type: SwitchParameter
Parameter Sets: Index
Aliases:
Required: False
Position: Named
Default value: False
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
OUTPUTS
NOTES
N/A
RELATED LINKS
https://celerium.github.io/ITGlue-PowerShellWrapper/site/Users/Get-ITGlueUser.html