core_v2_roleUsers Script API

Ben Tiedt — Fri, 23 Apr 2021 19:56:59 GMT

Current Revision posted to API Documentation by Ben Tiedt on 04/23/2021 19:56:59

Enables scripted content fragments to use Roles Users

AddUserToRole
IsUserInRoles
RemoveUserFromRole

Methods

AddUserToRole

Add a user to a role

Velocity

#set($additionalInfoResponse = $core_v2_roleUsers.AddUserToRole("%{ RoleId = $roleIdArg, RoleName = $roleNameArg, UserId = $userIdArg, UserName = $userNameArg }"))

JavaScript

var additionalInfoResponse = core_v2_roleUsers.AddUserToRole({ RoleId: roleIdArg, RoleName: roleNameArg, UserId: userIdArg, UserName: userNameArg });

Parameters

Name	Type	Description	Required
options	Options	Set of optional parameters including:	Required
RoleId	`Int32`	Either RoleId or RoleName is required	Optional
RoleName	`String`	Either RoleId or RoleName is required	Optional
UserId	`Int32`	Either UserId or Username is required	Optional
UserName	`String`	Either UserId or UserName is required	Optional

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

IsUserInRoles

Checks if a user is in 1 or more roles

Velocity

#set($booleanResponse = $core_v2_roleUsers.IsUserInRoles($userName, $roleNames))

JavaScript

var booleanResponse = core_v2_roleUsers.IsUserInRoles(userName, roleNames);

Parameters

Name	Type	Description	Required	Default	Options
userName	`String`	User Name	Required
roleNames	`IList of String`	Role Names	Required

Returns

Boolean

RemoveUserFromRole

Remove a user from a role

Velocity

#set($additionalInfoResponse = $core_v2_roleUsers.RemoveUserFromRole($roleId, "%{ UserId = $userIdArg, UserName = $userNameArg }"))

JavaScript

var additionalInfoResponse = core_v2_roleUsers.RemoveUserFromRole(roleId, { UserId: userIdArg, UserName: userNameArg });

Parameters

Name	Type	Description	Required
roleId	`Int32`	Role Id	Required
options	Options	Set of optional parameters including:	Required
UserId	`Int32`	Either UserId or Username is required	Optional
UserName	`String`	Either UserId or UserName is required	Optional

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]