System Security Users and Groups

Administrators click System > Administration > Security to define and manage users, groups and system security roles (roles). Users, groups and roles are not application-specific. See Creating and Managing Groups and Creating and Managing Users .

Every user must be assigned a user ID. Users can be added as native users or as references to users stored in external repositories (e.g. Active Directory).  Users can be externally authenticated with these standard providers.

  • LDAP

  • MSAD

  • Okta

  • PingFederate

  • Azure AD

  • SAML

For information about external authentication with standard providers, see the Installation and Configuration Guide.

Managing Users and Groups Using BRApi Functions

Administrators can manage users and groups with the following BRApi functions: 

BRApi.Security.Admin.GetUsers
BRApi.Security.Admin.GetUser
BRApi.Security.Admin.GetUser
BRApi.Security.Admin.SaveUser
BRApi.Security.Admin.RenameUser
BRApi.Security.Admin.DeleteUser
BRApi.Security.Admin.CopyUser
BRApi.Security.Admin.GetGroupsAndExclusionGroups
BRApi.Security.Admin.GetGroups
BRApi.Security.Admin.GetGroup
BRApi.Security.Admin.GetGroupInfoEx
BRApi.Security.Admin.SaveGroup
BRApi.Security.Admin.RenameGroup
BRApi.Security.Admin.DeleteGroup
BRApi.Security.Admin.CopyGroup
BRApi.Security.Admin.GetExclusionGroups
BRApi.Security.Admin.GetExclusionGroup
BRApi.Security.Admin.SaveExclusionGroup
BRApi.Security.Admin.RenameExclusionGroup
BRApi.Security.Admin.DeleteExclusionGroup
BRApi.Security.Admin.CopyExclusionGroup
BRApi.Security.Admin.GetSystemRoles
BRApi.Security.Admin.GetApplicationRoles
BRApi.Security.Admin.GetRole
BRApi.Security.Admin.CopyExclusionGroup

Examples 

Get a UserInfo object and change the User Description
    Dim objUserInfo As UserInfo = BRApi.Security.Admin.GetUser(si, "Administrator")
    If Not objUserInfo Is Nothing Then
        objUserInfo.User.Description = "New Description"
        BRApi.Security.Admin.SaveUser(si, objUserInfo.User, False, Nothing, TriStateBool.Unknown)
    End If
    
Get a Group and UserInfo object and add the Group to the User's list of parent Groups
    Dim objGroupInfo As GroupInfo = BRApi.Security.Admin.GetGroup(si, "TestGroup")
    If Not objGroupInfo Is Nothing Then
        
        Dim objUserInfo As UserInfo = BRApi.Security.Admin.GetUser(si, "TestUser")
        If Not objUserInfo Is Nothing Then
            
            If (Not objUserInfo.ParentGroups.ContainsKey(objGroupInfo.Group.UniqueID)) Then
                Dim parentGroupIDs As List(Of Guid) = objUserInfo.ParentGroups.Keys.ToList()
                parentGroupIDs.Add(objGroupInfo.Group.UniqueID)
                
                BRApi.Security.Admin.SaveUser(si, objUserInfo.User, True, parentGroupIDs, TriStateBool.Unknown)
            End If
        End If
    End If

Create a User

    Dim objUser As User = New User()
    objUser.Name = "NewUser"
    objUser.Text1 = "Test Text 1"
    BRApi.Security.Admin.SaveUser(si, objUser, False, Nothing, TriStateBool.Unknown)

Create a Group

    Dim objGroup As Group = New Group()
    objGroup.Name = "NewGroup"
    Dim objGroupInfo As GroupInfo = New GroupInfo()
    objGroupInfo.Group = objGroup
    BRApi.Security.Admin.SaveGroup(si, objGroupInfo, False, Nothing, TriStateBool.Unknown)