< Back

Add-JCAssociation

Thu Jan 16, 2020 8:42 am

NAME Add-JCAssociation



SYNOPSIS

Create an association between two object within the JumpCloud console.





SYNTAX

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

user_group | user | g_suite | office_365} [-Id] <System.String[]> [[-TargetId] <System.String>] [[-TargetName]

<System.String>] [[-Attributes] <System.Management.Automation.PSObject>] [[-TargetType] {user_group | system |

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

[-Force] [<CommonParameters>]



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

user_group | user | g_suite | office_365} [-Name] <System.String[]> [[-TargetId] <System.String>] [[-TargetName]

<System.String>] [[-Attributes] <System.Management.Automation.PSObject>] [[-TargetType] {user_group | system |

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

[-Force] [<CommonParameters>]





DESCRIPTION

The Add-JCAssociation function allows you to create associations of a specific object to a target object.





PARAMETERS

-Attributes <System.Management.Automation.PSObject>

Add attributes that define the association such as if they are an admin.



Required? false

Position? 12

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



-Name <System.String[]>

The name of the object.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-TargetId <System.String>

The unique id of the target object.



Required? false

Position? 10

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-TargetName <System.String>

The name of the target object.



Required? false

Position? 11

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.Management.Automation.PSObject







OUTPUTS

System.Object







NOTES









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



PS C:\\> Add-JCAssociation -Type:('radiusservers') -Id:('5c5c371704c4b477964ab4fa') -TargetType:('user_group')

-TargetId:('59f20255c9118021fa01b80f')



Create an association between the radius server "5c5c371704c4b477964ab4fa" and the user group

"59f20255c9118021fa01b80f".

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



PS C:\\> Add-JCAssociation -Type:('radiusservers') -Name:('RadiusServer1') -TargetType:('user_group')

-TargetName:('All Users')



Create an association between the radius server "RadiusServer1" and the user group "All Users".



RELATED LINKS

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