Add-CCSADUserToSecurityGroup
Add-CCSADUserToSecurityGroup
SYNOPSIS
Adds a user to a security group in Active Directory using the CCS API.
SYNTAX
__AllParameterSets
Add-CCSADUserToSecurityGroup [-UserName] <string> [-SecurityGroupName] <string>
[[-DomainOUPath] <string>] [-Domain] <string> [-Url] <string> [-CCSCredential] <pscredential>
[[-DomainCredential] <pscredential>] [[-PasswordIsEncrypted] <bool>] [<CommonParameters>]
ALIASES
This cmdlet has the following aliases,
DESCRIPTION
Adds a user to a security group in Active Directory using the CCS API.
EXAMPLES
EXAMPLE 1
Add-CCSADUserToSecurityGroup -UserName “jdoe” -SecurityGroupName “Domain Users” -DomainOUPath “OU=Users,DC=example,DC=com” -Domain “example.com” -Url “https://example.com/CCSWebservice/CCS.asmx” -CCSCredential $ccsCredential -DomainCredential $domainCredential
PARAMETERS
-CCSCredential
The credentials for the CCS API.
Type: System.Management.Automation.PSCredential
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
Position: 5
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Domain
The domain name where the security group resides.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
Position: 3
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-DomainCredential
The credentials for the domain where the security group resides.
Type: System.Management.Automation.PSCredential
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
Position: 6
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-DomainOUPath
The Organizational Unit (OU) path of the domain where the security group resides.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
Position: 2
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-PasswordIsEncrypted
Indicates whether the password is encrypted. Default is $false.
Type: System.Boolean
DefaultValue: False
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
Position: 7
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-SecurityGroupName
The name of the security group to which the user will be added.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
Position: 1
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Url
The URL of the CCS API.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
Position: 4
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-UserName
The username of the user to be added to the security group.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
Position: 0
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.