Get-ITGlueDomain
SYNOPSIS
List or show all domains
SYNTAX
Get-ITGlueDomain [-OrganizationID <Int64>] [-FilterID <Int64>] [-FilterOrganizationID <Int64>] [-Sort <String>]
[-PageNumber <Int64>] [-PageSize <Int32>] [-Include <String>] [-AllResults] [<CommonParameters>]
DESCRIPTION
The Get-ITGlueDomain cmdlet list or show all domains in your account or from a specified organization
This function can call the following endpoints: Index = /domains /organizations/:organization_id/relationships/domains
EXAMPLES
EXAMPLE 1
Get-ITGlueDomain
Returns the first 50 results from your ITGlue account
EXAMPLE 2
Get-ITGlueDomain -OrganizationID 12345
Returns the domains from the defined organization id
EXAMPLE 3
Get-ITGlueDomain -PageNumber 2 -PageSize 10
Returns the first 10 results from the second page for domains in your ITGlue account
PARAMETERS
-OrganizationID
A valid organization Id in your Account
Type: Int64
Parameter Sets: (All)
Aliases: org_id, organization_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-FilterID
The domain id to filter for
Type: Int64
Parameter Sets: (All)
Aliases: filter_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-FilterOrganizationID
The organization id to filter for
Type: Int64
Parameter Sets: (All)
Aliases: filter_organization_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: ‘created_at’, ‘updated_at’ ‘-created_at’, ‘-updated_at’
Type: String
Parameter Sets: (All)
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: (All)
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: (All)
Aliases: page_size
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Include
Include specified assets
Allowed values: ‘passwords’, ‘attachments’, ‘user_resource_accesses’, ‘group_resource_accesses’
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
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: (All)
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/Domains/Get-ITGlueDomain.html