Enables scripted content fragments to use Roles Users
Methods
AddUserToRole
Add a user to a role
Usage
#set($additionalInfoResponse = $core_v2_roleUsers.AddUserToRole("%{RoleId = $roleIdArg, RoleName = $roleNameArg, UserId = $userIdArg, UserName = $userNameArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
RoleId | int | Either RoleId or RoleName is required | Optional | ||
RoleName | string | Either RoleId or RoleName is required | Optional | ||
UserId | int | Either UserId or Username is required | Optional | ||
UserName | string | Either UserId or UserName is required | Optional |
Return Type
IsUserInRoles
Checks if a user is in 1 or more roles
Usage
#set($booleanResponse = $core_v2_roleUsers.IsUserInRoles($userName, $roleNames))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userName | string | User Name | Required | ||
roleNames | IList<string> | Role Names | Required |
Return Type
bool
RemoveUserFromRole
Remove a user from a role
Usage
#set($additionalInfoResponse = $core_v2_roleUsers.RemoveUserFromRole($roleId, "%{UserId = $userIdArg, UserName = $userNameArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
roleId | int | Role Id | Required | ||
UserId | int | Either UserId or Username is required | Optional | ||
UserName | string | Either UserId or UserName is required | Optional |