Add JCAssociation

---

external help file: JumpCloud-help.xml Module Name: JumpCloud online version: https://github.com/TheJumpCloud/support/wiki/Add-JCAssociation schema: 2.0.0

Add-JCAssociation

SYNOPSIS

Create an association between two object within the JumpCloud console.

SYNTAX

ById (Default)

Add-JCAssociation [-Type] <String> [-Force] [-Id] <String[]>
 [[-TargetType] <String[]>] [[-TargetId] <String>] [[-TargetName] <String>] [[-Attributes] <PSObject>]
 [<CommonParameters>]

ByName

Add-JCAssociation [-Type] <String> [-Force] [-Name] <String[]>
 [[-TargetType] <String[]>] [[-TargetId] <String>] [[-TargetName] <String>] [[-Attributes] <PSObject>]
 [<CommonParameters>]

DESCRIPTION

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

EXAMPLES

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".

PARAMETERS

-Attributes

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

Type: System.Management.Automation.PSObject
Parameter Sets: (All)
Aliases: compiledAttributes

Required: False
Position: 12
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Force

Bypass user prompts and dynamic ValidateSet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Id

The unique id of the object.

Type: System.String[]
Parameter Sets: ById
Aliases: _id

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Name

The name of the object.

Type: System.String[]
Parameter Sets: ByName
Aliases: domain, displayName, username

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TargetId

The unique id of the target object.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TargetName

The name of the target object.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TargetType

The type of the target object.

Type: System.String[]
Parameter Sets: (All)
Aliases: TargetSingular
Accepted values: user, user_group, system, system_group, policy, command, application, g_suite, ldap_server, office_365, radius_server

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Type

The type of the object.

Type: System.String
Parameter Sets: (All)
Aliases: TypeNameSingular
Accepted values: command, ldap_server, policy, application, radius_server, system_group, system, user_group, user, g_suite, office_365

Required: True
Position: 0
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.

INPUTS

System.String

System.Management.Automation.SwitchParameter

System.String[]

System.Management.Automation.PSObject

OUTPUTS

System.Object

NOTES

RELATED LINKS