Share via

Get-NAVServerUserPermissionSet

  • Reference
Module:
Microsoft.BusinessCentral.Management

Returns permission set information for Business Central users.

Syntax

Get-NAVServerUserPermissionSet
   [-AppName <String>]
   [-AppPublisher <String>]
   [-Tenant <TenantId>]
   [-CompanyName <String>]
   [-PermissionSetId <String>]
   [-Sid <String>]
   [-WindowsAccount <String>]
   [-UserName <String>]
   [-ServerInstance] <String>
   [-Force]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]

Description

Use the Get-NAVServerUserPermissionSet cmdlet to return permission set information for a Business Central user. Specifically, the cmdlet returns the following information for each relevant user:

User Security ID
PermissionSet
Company Name
User Name
Permission Set Name

You can also use any one of these values, or any combination of these values, to filter the return.

Examples

EXAMPLE 1

Get-NAVServerUserPermissionSet BC

This example returns permission sets for all current nav_now users.

EXAMPLE 2

Get-NAVServerUserPermissionSet BC -WindowsAccount cronus\chris

User Security ID   : b5013678-36e5-4469-8f07-dcc453fed66f
PermissionSet ID   : SUPER
Company Name       : CRONUS International Ltd
User Name          : cronuschris
PermissionSet Name : This role has all permissions.

This example returns information for a specific user, filtered by the user's Windows account name.

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, such as Microsoft.

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

-CompanyName

The name of a company in the Business Central database. If this argument is not included in the cmdlet, users in the default company are returned.

Type:String
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

-PermissionSetId

The ID of a permission set, such as RES-JOURNAL or SUPER.

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

-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 a 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:False
Accept pipeline input:False
Accept wildcard characters:False

-Tenant

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

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 a 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:False
Accept pipeline input:False
Accept wildcard characters:False

-WindowsAccount

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

You can use 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:False
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.

Outputs

System.Data.DataTable

Returns the permission set information as a table.