CurrentUser Control

Use the CurrentUser component to check the Windows group membership of a Windows user. For more information, see General Component Properties,  Methods, and Events.

 

Properties

Property

Description

AuthenticationType

Gets the type of authentication used to identify the user. (String)

IsAnonymous

Gets a value that indicates whether the user account is identified as an anonymous account by the system. (Boolean)

IsAuthenticated

Gets a value that indicates whether the user has been authenticated by the system. (Boolean)

IsGuest

Gets a value that indicates whether the user account is identified as a Guest account by the system. (Boolean)

IsSystem

Gets a value that indicates whether the user account is identified as a System account by the system. (Boolean)

 

Methods

Method

Description

Parameters

Return Type

IsInRole

Determines whether the user belongs to the group with the specified name. Returns True if the current principal is a member of the specified Windows user group; otherwise, returns False. Note the role input parameter is case insensitive and should indicate whether the role is built-in, machine-specific, or domain-specific using this format:

BUILTIN\RoleNameHere

MachineName\RoleNameHere

DomainName\RoleNameHere

If the role parameter is supplied without the BUILTIN, MachineName, or DomainName specifier, the method defaults to BUILTIN.

Note: The spelling for the BUILTIN roles in string format differs from the spelling used in the WindowsBuiltInRole enumeration. For example, the spelling for an administrator in the enumeration is "Administrator", not "Administrators".

See the MSDN WindowsPrincipal.IsInRole Method (String) topic for a list of built-in local groups.

String

Boolean

IsInRole

Determines whether the user belongs to the group with the specified WindowsBuiltInRole. See the MSDN  WindowsBuiltInRole Enumeration topic for more information.

WindowsBuiltInRole role

Boolean

 

Related information

Using the CurrentUser Control

 


Privacy | Trademarks | Terms of Use | Feedback

Updated: 18 June 2020

© 2016 - 2020 Pegasystems Inc.  Cambridge, MA All rights reserved.

 

OpenSpan data classification label