Remove JCGsuiteMember - TheJumpCloud/support GitHub Wiki

Remove-JCGsuiteMember

SYNOPSIS

Removes a user or usergroup from a GSuite instance

SYNTAX

ByName

Remove-JCGsuiteMember [-Name <String>] [-Username <String>] [-UserID <String>] [-GroupID <String>]
 [-GroupName <String>] [<CommonParameters>]

ByID

Remove-JCGsuiteMember [-ID <String>] [-Username <String>] [-UserID <String>] [-GroupID <String>]
 [-GroupName <String>] [<CommonParameters>]

DESCRIPTION

The Remove-JCGsuiteMember function allows you to remove users or UserGroups from a GSuite Cloud Directory instance in your organization

EXAMPLES

Example 1

Remove-JCGsuiteMember -Name 'JumpCloud Gsuite' -Username 'john.doe'

Removes the user john.doe from the JumpCloud GSuite CloudDirectory instance

Example 2

Remove-JCGsuiteMember -Name 'JumpCloud Gsuite' -GroupName 'Sales Users'

Removes the Sales Users UserGroup from the JumpCloud GSuite CloudDirectory instance

PARAMETERS

-GroupID

A UserGroup ID to remove to the directory

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

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

-GroupName

A UserGroup name to remove to the directory

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

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

-ID

The ID of cloud directory instance

Type: System.String
Parameter Sets: ByID
Aliases: _id

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

-Name

The name of cloud directory instance

Type: System.String
Parameter Sets: ByName
Aliases:

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

-UserID

A UserID to remove to the directory

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

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

-Username

A username to remove to the directory

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

Required: False
Position: Named
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

OUTPUTS

System.Object

NOTES

RELATED LINKS

⚠️ **GitHub.com Fallback** ⚠️