Get-JCAssociation

NAME Get-JCAssociation



SYNOPSIS

The function Get-JCAssociation can be used to query an object's associations and then provide information about

how objects are associated with one another.





SYNTAX

Get-JCAssociation [-Type] {command | ldap_server | policy | application | radius_server | system_group | system |

user_group | user | g_suite | office_365} [-Id] <System.String[]> [[-TargetType] {user_group | system |

system_group | user | policy | command | application | g_suite | ldap_server | office_365 | radius_server}]

[[-Direct]] [[-Indirect]] [[-IncludeInfo]] [[-IncludeNames]] [[-IncludeVisualPath]] [[-Fields] <System.Array>]

[[-Filter] <System.String>] [[-Limit] <System.Int32>] [[-Skip] <System.Int32>] [[-Paginate] <System.Boolean>]

[-Force] [<CommonParameters>]



Get-JCAssociation [-Type] {command | ldap_server | policy | application | radius_server | system_group | system |

user_group | user | g_suite | office_365} [-Name] <System.String[]> [[-TargetType] {user_group | system |

system_group | user | policy | command | application | g_suite | ldap_server | office_365 | radius_server}]

[[-Direct]] [[-Indirect]] [[-IncludeInfo]] [[-IncludeNames]] [[-IncludeVisualPath]] [[-Fields] <System.Array>]

[[-Filter] <System.String>] [[-Limit] <System.Int32>] [[-Skip] <System.Int32>] [[-Paginate] <System.Boolean>]

[-Force] [<CommonParameters>]





DESCRIPTION

The Get-JCAssociation function allows you to view the associations of a specific object to a target object.





PARAMETERS

-Direct <System.Management.Automation.SwitchParameter>

Returns only "Direct" associations.



Required? false

Position? 5

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Fields <System.Array>

An array of the fields/properties/columns you want to return from the search.



Required? false

Position? 95

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Filter <System.String>

Filters to narrow down search.



Required? false

Position? 96

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Force <System.Management.Automation.SwitchParameter>

Bypass user prompts and dynamic ValidateSet.



Required? false

Position? named

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Id <System.String[]>

The unique id of the object.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-IncludeInfo <System.Management.Automation.SwitchParameter>

Appends "Info" and "TargetInfo" properties to output.



Required? false

Position? 7

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-IncludeNames <System.Management.Automation.SwitchParameter>

Appends "Name" and "TargetName" properties to output.



Required? false

Position? 8

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-IncludeVisualPath <System.Management.Automation.SwitchParameter>

Appends "visualPathById", "visualPathByName", and "visualPathByType" properties to output.



Required? false

Position? 9

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Indirect <System.Management.Automation.SwitchParameter>

Returns only "Indirect" associations.



Required? false

Position? 6

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Limit <System.Int32>

The number of items you want to return per API call.



Required? false

Position? 97

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <System.String[]>

The name of the object.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Paginate <System.Boolean>

Whether or not you want to paginate through the results.



Required? false

Position? 99

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Skip <System.Int32>

The number of items you want to skip over per API call.



Required? false

Position? 98

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-TargetType <System.String[]>

The type of the target object.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Type <System.String>

The type of the object.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String





System.Management.Automation.SwitchParameter





System.String[]





System.Array





System.Int32





System.Boolean







OUTPUTS

System.Object







NOTES









-------------------------- Example 1 --------------------------



PS C:\\> Get-JCAssociation -Type:user_group -Name:employee -TargetType:users



List all "users" that are associated with the user_group "employee".

-------------------------- Example 2 --------------------------



PS C:\\> Get-JCAssociation -Type:system -Id:5c9a95f84tdo1376318g5148



List all associations with the system "5c9a95f84tdo1376318g5148".

-------------------------- Example 3 --------------------------



PS C:\\> Get-JCAssociation -Type:system -Id:5c9a95f84tdo1376318g5148 -TargetType:users -Direct



List all "users" that have a direct association with the system "5c9a95f84tdo1376318g5148".

-------------------------- Example 4 --------------------------



PS C:\\> Get-JCAssociation -Type:system -Id:5c9a95f84tdo1376318g5148 -TargetType:users -Indirect



List all "users" that have a indirect association with the system "5c9a95f84tdo1376318g5148".

-------------------------- Example 5 --------------------------



PS C:\\> Get-JCAssociation -Type:system -Id:5c9a95f84tdo1376318g5148 -TargetType:users -IncludeInfo -IncludeNames

-IncludeVisualPath



List all "users" that are associated with the system "5c9a95f84tdo1376318g5148" and also get additional metadata

about each object.



RELATED LINKS

Online Version: https://github.com/TheJumpCloud/support ... ssociation