Skip to content

Commit

Permalink
Merge pull request #554 from TheJumpCloud/SA-3040_Add-Remove-JCCloudD…
Browse files Browse the repository at this point in the history
…irectoryMember

SA-3040: Add/Remove-JCCloudDirectory Member Functions
  • Loading branch information
gweinjc authored Jan 17, 2024
2 parents d728c5c + 3972ced commit 7d41448
Show file tree
Hide file tree
Showing 18 changed files with 7,010 additions and 4,632 deletions.
149 changes: 149 additions & 0 deletions PowerShell/JumpCloud Module/Docs/Add-JCGsuiteMember.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
---
external help file: JumpCloud-help.xml
Module Name: JumpCloud
online version: https://github.com/TheJumpCloud/support/wiki/
schema: 2.0.0
---

# Add-JCGsuiteMember

## SYNOPSIS
Adds a user or usergroup to a GSuite instance

## SYNTAX

### ByName
```
Add-JCGsuiteMember [-Name <String>] [-Username <String>] [-UserID <String>] [-GroupID <String>]
[-GroupName <String>] [<CommonParameters>]
```

### ByID
```
Add-JCGsuiteMember [-ID <String>] [-Username <String>] [-UserID <String>] [-GroupID <String>]
[-GroupName <String>] [<CommonParameters>]
```

## DESCRIPTION
The Add-JCGsuiteMember function allows you to add users or UserGroups to a GSuite Cloud Directory instance in your organization

## EXAMPLES

### Example 1
```powershell
Add-JCGsuiteMember -Name 'JumpCloud Gsuite' -Username 'john.doe'
```

Adds the user john.doe to the JumpCloud GSuite CloudDirectory instance

### Example 2
```powershell
Add-JCGsuiteMember -Name 'JumpCloud Gsuite' -GroupName 'Sales Users'
```

Adds the Sales Users UserGroup to the JumpCloud GSuite CloudDirectory instance

## PARAMETERS

### -GroupID
A UserGroup ID to add to the directory

```yaml
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 add to the directory
```yaml
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
```yaml
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
```yaml
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 add to the directory
```yaml
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 add to the directory
```yaml
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](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
## OUTPUTS
### System.Object
## NOTES
## RELATED LINKS
149 changes: 149 additions & 0 deletions PowerShell/JumpCloud Module/Docs/Add-JCOffice365Member.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
---
external help file: JumpCloud-help.xml
Module Name: JumpCloud
online version: https://github.com/TheJumpCloud/support/wiki/
schema: 2.0.0
---

# Add-JCOffice365Member

## SYNOPSIS
Adds a user or usergroup to an Office365 instance

## SYNTAX

### ByName
```
Add-JCOffice365Member [-Name <String>] [-Username <String>] [-UserID <String>] [-GroupID <String>]
[-GroupName <String>] [<CommonParameters>]
```

### ByID
```
Add-JCOffice365Member [-ID <String>] [-Username <String>] [-UserID <String>] [-GroupID <String>]
[-GroupName <String>] [<CommonParameters>]
```

## DESCRIPTION
The Add-JCOffice365Member function allows you to add users or UserGroups to a GSuite Cloud Directory instance in your organization

## EXAMPLES

### Example 1
```powershell
Add-JCOffice365Member -Name 'JumpCloud Office365' -Username 'john.doe'
```

Adds the user john.doe to the JumpCloud Office365 CloudDirectory instance

### Example 2
```powershell
Add-JCOffice365Member -Name 'JumpCloud Office365' -GroupName 'Sales Users'
```

Adds the Sales Users UserGroup to the JumpCloud Office365 CloudDirectory instance

## PARAMETERS

### -GroupID
A UserGroup ID to add to the directory

```yaml
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 add to the directory
```yaml
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
```yaml
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
```yaml
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 add to the directory
```yaml
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 add to the directory
```yaml
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](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
## OUTPUTS
### System.Object
## NOTES
## RELATED LINKS
6 changes: 3 additions & 3 deletions PowerShell/JumpCloud Module/Docs/Connect-JCOnline.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ The Connect-JCOnline function sets the global variable $JCAPIKEY
## SYNTAX

```
Connect-JCOnline [-force] [[-JumpCloudApiKey] <String>] [[-JumpCloudOrgId] <String>]
[[-JCEnvironment] <String>] [<CommonParameters>]
Connect-JCOnline [-force] [-JumpCloudApiKey] <String> [[-JumpCloudOrgId] <String>] [[-JCEnvironment] <String>]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -88,7 +88,7 @@ Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Expand Down
14 changes: 13 additions & 1 deletion PowerShell/JumpCloud Module/Docs/JumpCloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Module Name: JumpCloud
Module Guid: 31c023d1-a901-48c4-90a3-082f91b31646
Download Help Link: https://github.com/TheJumpCloud/support/wiki
Help Version: 2.9.1
Help Version: 2.10.0
Locale: en-US
---

Expand All @@ -17,6 +17,12 @@ Create an association between two object within the JumpCloud console.
### [Add-JCCommandTarget](Add-JCCommandTarget.md)
Associates a JumpCloud system or a JumpCloud system group with a JumpCloud command

### [Add-JCGsuiteMember](Add-JCGsuiteMember.md)
Adds users or usergroups to a GSuite Cloud Directory Instance

### [Add-JCOffice365Member](Add-JCOffice365Member.md)
Adds users or usergroups to an Office365 Cloud Directory Instance

### [Add-JCRadiusReplyAttribute](Add-JCRadiusReplyAttribute.md)
Adds Radius reply attributes to a JumpCloud user group.

Expand Down Expand Up @@ -166,6 +172,12 @@ Removes a JumpCloud Command Result
### [Remove-JCCommandTarget](Remove-JCCommandTarget.md)
Removes the association between a JumpCloud system or a JumpCloud system group from a JumpCloud command

### [Remove-JCGsuiteMember](Remove-JCGsuiteMember.md)
Removes users or usergroups from a GSuite Cloud Directory Instance

### [Remove-JCOffice365Member](Remove-JCOffice365Member.md)
Removes users or usergroups from an Office365 Cloud Directory Instance

### [Remove-JCPolicy](Remove-JCPolicy.md)
Removes a JumpCloud Policy

Expand Down
Loading

0 comments on commit 7d41448

Please sign in to comment.