Share via


Remove-NAVServerUserPermissionSet

Removes a permission set from the list of permission sets that are assigned to a Business Central user.

Syntax

WindowsAccount (Default)

Remove-NAVServerUserPermissionSet
    [-ServerInstance] <String>
    -PermissionSetId <String>
    -WindowsAccount <String>
    [-Scope <PermissionScope>]
    [-AppName <String>]
    [-AppPublisher <String>]
    [-Tenant <TenantId>]
    [-CompanyName <String>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Sid

Remove-NAVServerUserPermissionSet
    [-ServerInstance] <String>
    -PermissionSetId <String>
    -Sid <String>
    [-Scope <PermissionScope>]
    [-AppName <String>]
    [-AppPublisher <String>]
    [-Tenant <TenantId>]
    [-CompanyName <String>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UserName

Remove-NAVServerUserPermissionSet
    [-ServerInstance] <String>
    -PermissionSetId <String>
    -UserName <String>
    [-Scope <PermissionScope>]
    [-AppName <String>]
    [-AppPublisher <String>]
    [-Tenant <TenantId>]
    [-CompanyName <String>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObject

Remove-NAVServerUserPermissionSet
    [-ServerInstance] <String>
    -PermissionSetId <String>
    -InputObject <DataRow>
    [-Scope <PermissionScope>]
    [-AppName <String>]
    [-AppPublisher <String>]
    [-Tenant <TenantId>]
    [-CompanyName <String>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use the Remove-NAVServerUserPermissionSet cmdlet to remove a permission set that is assigned to a Business Central user. You can use the Get-NAVServerUserPermissionSet cmdlet to determine which permission sets are currently assigned to a particular user.

Examples

EXAMPLE 1

Remove-NAVServerUserPermissionSet BC -Sid S-1-5-20 -PermissionSetId AVOCADO

This example removes the built-in account (Network Service) from the AVOCADO permission set.

Parameters

-AppName

Specifies the name of the Business Central extension.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AppPublisher

Specifies the publisher of the Business Central extension.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CompanyName

Specifies the name of a company in the Business Central database. The specified user permission sets are removed for that company only.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before executing the command.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specifies the DataRow object that identifies the user to remove the permission set from. You can pass this object from the Get-NAVServerUserPermissionSet cmdlet.

Parameter properties

Type:DataRow
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

InputObject
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-PermissionSetId

Specifies the ID of a permission set, which is a string such as RES-JOURNAL or SUPER.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Scope

Not Specified.

Parameter properties

Type:PermissionScope
Default value:None
Accepted values:System, Tenant
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ServerInstance

Specifies the name of a Business Central Server instance, for example, BC or myinstance. You can specify either the full name of an instance, such as MicrosoftDynamicsNavServer$myinstance or the short name such as myinstance.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-Sid

Specifies a security identifier (SID) of the Business Central user. The SID is a unique value that identifies a Windows user account.

You can use the Sid, UserName, or WindowsAccount parameters to identify the user. If you use the Sid parameter, then do not set the UserName or WindowsAccount parameters.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Sid
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Tenant

Specifies the ID of the tenant that is mounted of the Business Central Server instance to which the user belongs.

You can omit the Tenant parameter only if the Business Central Server instance is not configured to run multiple tenants.

Parameter properties

Type:TenantId
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Id

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-UserName

Specifies the user name of the Business Central user. The user name is defined by the User Name field in a user's account in Business Central.

You can use the UserName, WindowsAccount or Sid parameters to identify the user. If you use the Username parameter, then you cannot use the Windows Account or Sid parameters.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UserName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WindowsAccount

Specifies the Windows user name of the Business Central user. The value has the domain\username format.

You can use either the WindowsAccount, UserName, or Sid parameters to identify the user. If you use the WindowsAccount parameter, then you cannot use the UserName or Sid parameters.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

WindowsAccount
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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.

Inputs

System.String

You can pipe a string that contains a Business Central Server instance name to the cmdlet.

System.Data.DataRow

You can pass this object from the Get-NAVServerUserPermissionSet cmdlet to remove a permission set from a user.

Outputs

None