SecurityObject Class

Namespace: bcpDevKit.Entities.Configuration
Assembly: bcpDevKit.dll

Syntax

public abstract class SecurityObject

Properties

Type

Name

Description

../../../../_images/prop.ico IEnumerable<UserObject>

Users

Gets all the configured users.

../../../../_images/prop.ico IEnumerable<GroupObject>

Groups

Gets all the configured groups.

../../../../_images/prop.ico IEnumerable<RoleObject>

Roles

Gets all the configured roles (only working for Vault 2019 and above).

Methods

Type

Name

Description

../../../../_images/method.ico UserObject

AddUser(string userName)

Creates a new user if no one with the specified name exists.

../../../../_images/method.ico UserObject

GetUser(string userName)

Retrieves the user with the specified name if exists.

../../../../_images/method.ico GroupObject

AddGroup(string groupName)

Creates a new group if no one with the specified name exists.

../../../../_images/method.ico GroupObject

GetGroup(string groupName)

Retrieves the group with the specified name if exists.

../../../../_images/method.ico RoleObject

AddRole(string roleName)

Creates a new role if no one with the specified name exists.

../../../../_images/method.ico RoleObject

GetRole(string roleName)

Retrieves the role with the specified name if exists.

../../../../_images/method.ico void

RemoveRole(string roleName

Removes the role if one with the specified name exists.

Examples

Disable the export of all configuration entities

var security = bcpService.EntitiesTable.Vault.Security;
var user = security.AddUser("Angela");