Get-NAVServerUserPermissionSet
Returns permission set information for Business Central users.
Syntax
Default (Default)
Get-NAVServerUserPermissionSet
[-AppName <String>]
[-AppPublisher <String>]
[-Tenant <TenantId>]
[-CompanyName <String>]
[-PermissionSetId <String>]
[-Sid <String>]
[-WindowsAccount <String>]
[-UserName <String>]
[-ServerInstance] <String>
[-Force]
[<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.
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, such as Microsoft.
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
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.
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 |
-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 |
-PermissionSetId
The ID of a permission set, such as RES-JOURNAL or SUPER.
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 |
-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 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.
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 |
-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.
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 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.
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 |
-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.
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 |
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.
Outputs
System.Data.DataTable
Returns the permission set information as a table.