core_v2_permission Script API

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

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

Enables scripted content fragments to use Permissions

Methods

Obsolete in 11.0. Use $core_v3_permission.Get(...) instead.

#set($permissionCheckResponse = $core_v2_permission.Get($permissionId, $userId))

var permissionCheckResponse = core_v2_permission.Get(permissionId, userId);

Name	Type	Description	Required	Default	Options
permissionId	`Guid`	Permission Id	Required
userId	`Int32`	User Id	Required

Obsolete in 11.0. Use $core_v3_permission.Get(...) instead.

#set($permissionCheckResponse = $core_v2_permission.Get($permissionId, $userId, $contentId, $contentTypeId))

var permissionCheckResponse = core_v2_permission.Get(permissionId, userId, contentId, contentTypeId);

Name	Type	Description	Required
permissionId	`Guid`	Permission Id	Required
userId	`Int32`	User Id	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required

Obsolete in 11.0. Use $core_v3_permission.Get(...) instead.

#set($permissionCheckResponse = $core_v2_permission.Get($permissionId, $userId, $entityId, $entityTypeId, $entityPermissionType))

var permissionCheckResponse = core_v2_permission.Get(permissionId, userId, entityId, entityTypeId, entityPermissionType);

Name	Type	Description	Required
permissionId	`Guid`	Permission Id	Required
userId	`Int32`	User Id	Required
entityId	`Guid`	Entity Id	Required
entityTypeId	`Guid`	Entity Type Id	Required
entityPermissionType	`String`	Entity Permission Type	Required

Gets a role

#set($permissionCheckResponse = $core_v2_permission.Get($application, $id, $roleId, $permissionId))

var permissionCheckResponse = core_v2_permission.Get(application, id, roleId, permissionId);

Name	Type	Description	Required
application	`String`	Application	Required
id	`Nullable of Int32`	Id	Required
roleId	`Int32`	Role Id	Required
permissionId	`String`	Permission Id	Required

Gets a role

#set($permissionCheckResponse = $core_v2_permission.Get($application, $id, $roleId, $permissionId, "%{ Include = $includeArg }"))

var permissionCheckResponse = core_v2_permission.Get(application, id, roleId, permissionId, { Include: includeArg });

Name	Type	Description	Required	Options
application	`String`	Application	Required
id	`Nullable of Int32`	Id	Required
roleId	`Int32`	Role Id	Required
permissionId	`String`	Permission Id	Required
options	Options	Set of optional parameters including:	Required
Include	`String`	Include	Optional	denied, granted

Gets a role

#set($permissionCheckResponse = $core_v2_permission.Get($applicationTypeId, $applicationId, $roleId, $permissionId, "%{ Include = $includeArg }"))

var permissionCheckResponse = core_v2_permission.Get(applicationTypeId, applicationId, roleId, permissionId, { Include: includeArg });

Name	Type	Description	Required	Options
applicationTypeId	`Guid`	Application Type Id	Required
applicationId	`Guid`	Application Id	Required
roleId	`Int32`	Role Id	Required
permissionId	`String`	Permission Id	Required
options	Options	Set of optional parameters including:	Required
Include	`String`	Include	Optional	denied, granted

[[PermissionCheck Script API Type|PermissionCheck]]