Get-AXSecurityRole

  • Article

Important

This content is archived and is not being updated. For the latest documentation, see Microsoft Dynamics 365 product documentation. For the latest release plans, see Dynamics 365 and Microsoft Power Platform release plans.

Get-AXSecurityRole

Retrieves a list of the security roles within Microsoft Dynamics AX that the specified UserID is associated with.

Syntax

Parameter Set: Default
Get-AXSecurityRole -AxUserID <String> [-PartitionKey <String> ] [ <CommonParameters>]

Detailed description

The Get-AXSecurityRole cmdlet retrieves a list of the security roles within Microsoft Dynamics AX that the specified user ID is associated with.

Parameters

-AxUserID<String>

Specifies a Microsoft Dynamics AX UserID to retrieve security role membership information for.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PartitionKey<String>

Specifies the partition from which to return the security roles that are associated with a user. By default, the cmdlet returns the security roles in the initial partition. If both a user ID and a partition key are specified, and the user does not exist in the specified partition, an error is returned.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see about_CommonParameters https://go.microsoft.com/fwlink/?LinkID=113216

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

    You cannot pipe input to this cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

    The cmdlet does not generate any output.

Examples

This example returns the Microsoft Dynamics AX security roles that the user Vamsi Kuppa is a member of. The output is piped to the FL (format list) cmdlet to make it easier to read.

C:\PS>Get-AXSecurityRole -AxUserID VamsiK | FL

						

						
RecId       : 492999
Name        : Accountant
Description : Documents accounting events and responds to accounting inquiries
AOTName     : LedgerAccountant

RecId       : 493021
Name        : System administrator
Description : Maintains the Microsoft Dynamics AX system, has access to all art
ifacts in the system, and  cannot be modified
AOTName     : -SYSADMIN-

RecId       : 493026
Name        : System user
Description : System role for all users
AOTName     : SystemUser

New-AXSecurityRole

Get-AXPartitionInfo

Copyright Microsoft Corporation. All rights reserved.