Permissions Script API Type

Ben Tiedt — Wed, 20 Nov 2019 15:09:27 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 15:09:27

CheckPermission
List
Set

Methods

CheckPermission

Checks permission for a role

Velocity

#set($permissionCheckResponse = $core_v3_permission.CheckPermission($permissionId, $userId, "%{ ApplicationId = $applicationIdArg, ApplicationTypeId = $applicationTypeIdArg, ContentId = $contentIdArg, ContentTypeId = $contentTypeIdArg }"))

JavaScript

var permissionCheckResponse = core_v3_permission.CheckPermission(permissionId, userId, { ApplicationId: applicationIdArg, ApplicationTypeId: applicationTypeIdArg, ContentId: contentIdArg, ContentTypeId: contentTypeIdArg });

Parameters

Name	Type	Description	Required
permissionId	`Guid`	Permission Id	Required
userId	`Int32`	User Id	Required
ApplicationId	`Guid`	Application Id	Optional
ApplicationTypeId	`Guid`	Application Type Id	Optional
ContentId	`Guid`	Content Id	Optional
ContentTypeId	`Guid`	Content Type Id	Optional

Returns

[[PermissionCheck Script API Type|PermissionCheck]]

List

List permissions for a role

Velocity

#set($apiListResponse = $core_v3_permission.List($roleId, "%{ ApplicationId = $applicationIdArg, GroupId = $groupIdArg }"))

JavaScript

var apiListResponse = core_v3_permission.List(roleId, { ApplicationId: applicationIdArg, GroupId: groupIdArg });

Parameters

Name	Type	Description	Required
roleId	`Int32`	Role Id	Required
ApplicationId	`Guid`	Application Id	Optional
GroupId	`Int32`	Group Id	Optional

Returns

[[ApiList Script API Type|ApiList]] of [[PermissionEntry Script API Type|PermissionEntry]]

Set

Sets a permission for a role

Velocity

#set($additionalInfoResponse = $core_v3_permission.Set($isAllowed, $roleId, $permissionId, "%{ ApplicationId = $applicationIdArg, GroupId = $groupIdArg }"))

JavaScript

var additionalInfoResponse = core_v3_permission.Set(isAllowed, roleId, permissionId, { ApplicationId: applicationIdArg, GroupId: groupIdArg });

Parameters

Name	Type	Description	Required
isAllowed	`Boolean`	Is Allowed	Required
roleId	`Int32`	Role Id	Required
permissionId	`Guid`	Permission Id	Required
ApplicationId	`Guid`	Application Id	Optional
GroupId	`Int32`	Group Id	Optional

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]