Share via

Remove-NAVServerUserPermissionSet

  • Reference
Module:
Microsoft.BusinessCentral.Management

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

Syntax

Remove-NAVServerUserPermissionSet
      [-Scope <PermissionScope>]
      [-AppName <String>]
      [-AppPublisher <String>]
      [-Tenant <TenantId>]
      [-CompanyName <String>]
      -PermissionSetId <String>
      -WindowsAccount <String>
      [-ServerInstance] <String>
      [-Force]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-NAVServerUserPermissionSet
      [-Scope <PermissionScope>]
      [-AppName <String>]
      [-AppPublisher <String>]
      [-Tenant <TenantId>]
      [-CompanyName <String>]
      -PermissionSetId <String>
      -Sid <String>
      [-ServerInstance] <String>
      [-Force]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-NAVServerUserPermissionSet
      [-Scope <PermissionScope>]
      [-AppName <String>]
      [-AppPublisher <String>]
      [-Tenant <TenantId>]
      [-CompanyName <String>]
      -PermissionSetId <String>
      -UserName <String>
      [-ServerInstance] <String>
      [-Force]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-NAVServerUserPermissionSet
      [-Scope <PermissionScope>]
      [-AppName <String>]
      [-AppPublisher <String>]
      [-Tenant <TenantId>]
      [-CompanyName <String>]
      -PermissionSetId <String>
      -InputObject <DataRow>
      [-ServerInstance] <String>
      [-Force]
      [-ProgressAction <ActionPreference>]
      [-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.

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

-AppPublisher

Specifies the publisher of the Business Central extension.

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

-CompanyName

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

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

-Confirm

Prompts you for confirmation before executing the command.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

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

-PermissionSetId

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

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

-ProgressAction

A common PowerShell parameter that determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider. Learn more.

Type:ActionPreference
Aliases:proga
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Scope

Not Specified.

Type:PermissionScope
Accepted values:System, Tenant
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters: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.

Type:TenantId
Aliases:Id
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

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

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

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

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