Skip to content

Add-User

SYNOPSIS

Adds a user to a role using their SID

SYNTAX

FromPipeline (Default)

Add-User -Role <Role> [[-AccountName] <String>] [[-Sid] <String>] [<CommonParameters>]

FromName

Add-User -RoleName <String> [[-AccountName] <String>] [[-Sid] <String>] [<CommonParameters>]

FromId

Add-User -RoleId <Guid> [[-AccountName] <String>] [[-Sid] <String>] [<CommonParameters>]

DESCRIPTION

Adds a user to a role using their SID. Basic users are supported as they each have an artificial "SID" as well.

EXAMPLES

Example 1

{{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-AccountName

{{ Fill AccountName Description }}

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Role

{{ Fill Role Description }}

Type: Role
Parameter Sets: FromPipeline
Aliases:

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

-RoleId

{{ Fill RoleId Description }}

Type: Guid
Parameter Sets: FromId
Aliases:

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

-RoleName

{{ Fill RoleName Description }}

Type: String
Parameter Sets: FromName
Aliases:

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

-Sid

{{ Fill Sid Description }}

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
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

VideoOS.Platform.ConfigurationItems.Role

OUTPUTS

VideoOS.Platform.ConfigurationItems.User

NOTES

Online Help