< Back

Get-CrmUserSecurityRoles

Sat Jan 18, 2020 4:02 pm

NAME Get-CrmUserSecurityRoles



SYNOPSIS

Retrieves Security Roles assigned to a CRM User.





SYNTAX

Get-CrmUserSecurityRoles [-conn <CrmServiceClient>] [-UserId] <String> [-IncludeTeamRoles <SwitchParameter>]

[<CommonParameters>]





DESCRIPTION

The Get-CrmUserSecurityRoles cmdlet lets you retrieve Security Roles assigned to a CRM User.





PARAMETERS

-conn <CrmServiceClient>

A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-UserId <String>

An Id (guid) of CRM User.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-IncludeTeamRoles [<SwitchParameter>]

When you specify the IncludeTeamRoles switch, Security Roles from teams are also returned.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS









OUTPUTS









NOTES









-------------------------- Example 1 --------------------------



Get-CrmUserSecurityRoles -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d



This example retrieves Security Roles assigned to the CRM User.







RoleId RoleName TeamName BusinessUnitName

------ -------- -------- ----------------

cac2d2c7-c6f7-e411-80de-c4346bc520c0 Marketing Manager TeamA Contoso

57d5d2c7-c6f7-e411-80de-c4346bc520c0 Salesperson Contoso

...



-------------------------- Example 2 --------------------------



Get-CrmUserSecurityRoles -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -IncludeTeamRoles



This example retrieves Security Roles assigned to the CRM User and Teams which the CRM User belongs to.







RoleId RoleName TeamName BusinessUnitName

------ -------- -------- ----------------

cac2d2c7-c6f7-e411-80de-c4346bc520c0 Marketing Manager TeamA Contoso

57d5d2c7-c6f7-e411-80de-c4346bc520c0 Salesperson Contoso

...



-------------------------- Example 3 --------------------------



Get-CrmUserSecurityRoles f9d40920-7a43-4f51-9749-0549c4caf67d -IncludeTeamRoles



This example retrieves Security Roles assigned to the CRM User and Teams which the CRM User belongs to by omitting

parameter names.

When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.







RoleId RoleName TeamName BusinessUnitName

------ -------- -------- ----------------

cac2d2c7-c6f7-e411-80de-c4346bc520c0 Marketing Manager TeamA Contoso

57d5d2c7-c6f7-e411-80de-c4346bc520c0 Salesperson Contoso

...





RELATED LINKS