Add JCAssociation

Add-JCAssociation

SYNOPSIS

Create an association between two object within the JumpCloud console.

SYNTAX

ById (Default)

Add-JCAssociation [-Type] <String> [-Force] [-Fields <Array>] [-Filter <String>] -Id <String[]>
 [-Limit <Int32>] [-Paginate <Boolean>] [-Skip <Int32>] [-Attributes <PSObject>] [-TargetId <String>]
 [-TargetName <String>] [-TargetType <String[]>] [<CommonParameters>]

ByName

Add-JCAssociation [-Type] <String> [-Force] [-Fields <Array>] [-Filter <String>] [-Limit <Int32>]
 -Name <String[]> [-Paginate <Boolean>] [-Skip <Int32>] [-Attributes <PSObject>] [-TargetId <String>]
 [-TargetName <String>] [-TargetType <String[]>] [<CommonParameters>]

ByValue

Add-JCAssociation [-Type] <String> [-Force] [-Fields <Array>] [-Filter <String>] [-Limit <Int32>]
 [-Paginate <Boolean>] [-Skip <Int32>] [-Attributes <PSObject>] [-TargetId <String>] [-TargetName <String>]
 [-TargetType <String[]>] [<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: PSObject
Parameter Sets: (All)
Aliases: compiledAttributes

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

-Fields

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

Type: Array
Parameter Sets: (All)
Aliases:

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

-Filter

Filters to narrow down search.

Type: String
Parameter Sets: (All)
Aliases:

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

-Force

Bypass user prompts and dynamic ValidateSet.

Type: 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: String[]
Parameter Sets: ById
Aliases: _id

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

-Limit

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

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Name

The name of the object.

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

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

-Paginate

Whether or not you want to paginate through the results.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-Skip

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

Type: Int32
Parameter Sets: (All)
Aliases:

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

-TargetId

The unique id of the target object.

Type: String
Parameter Sets: (All)
Aliases:

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

-TargetName

The name of the target object.

Type: String
Parameter Sets: (All)
Aliases:

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

-TargetType

The type of the target object.

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

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

-Type

The type of the object.

Type: 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.Array

System.String[]

System.Int32

System.Boolean

System.Management.Automation.PSObject

OUTPUTS

System.Object

NOTES

RELATED LINKS