Enables scripted content fragments to use Roless
Methods
Create
Creates a role
Usage
#set($roleResponse = $core_v2_role.Create($name, $description))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
name | string | Name | Required | ||
description | string | Description | Required |
Return Type
Create
Creates a role
Usage
#set($roleResponse = $core_v2_role.Create($name, $description, "%{GroupId = $groupIdArg, Include = $includeArg, RoleId = $roleIdArg, RoleName = $roleNameArg, UserId = $userIdArg, Username = $usernameArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
name | string | Name | Required | ||
description | string | Description | Required | ||
GroupId | int | Group Id | Optional | ||
Include | string | Include | Optional | user | |
RoleId | int | Either RoleId or RoleName is required when using include=user | Optional | ||
RoleName | string | Either RoleId or RoleName is required when using include=user | Optional | ||
UserId | int | Either UserId or Username is required when using include=user | Optional | ||
Username | string | Either UserId or Username is required when using include=user | Optional |
Return Type
CreateFromLdap
Creates a role based on an LDAP group
Usage
#set($roleResponse = $core_v2_role.CreateFromLdap($ldapGroupName))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ldapGroupName | string | Ldap Group Name | Required |
Return Type
CreateFromLdap
Creates a role based on an LDAP group
Usage
#set($roleResponse = $core_v2_role.CreateFromLdap($ldapGroupName, $distinguishedName))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ldapGroupName | string | Ldap Group Name | Required | ||
distinguishedName | string | Distinguished Name | Required |
Return Type
Delete
Deletes a role
Usage
#set($additionalInfoResponse = $core_v2_role.Delete($roleId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
roleId | int | Role Id | Required |
Return Type
Delete
Deletes a role
Usage
#set($additionalInfoResponse = $core_v2_role.Delete($roleId, "%{Include = $includeArg, UserId = $userIdArg, Username = $usernameArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
roleId | int | Role Id | Required | ||
Include | string | Include | Optional | user | |
UserId | int | User Id | Optional | ||
Username | string | Username | Optional |
Return Type
Find
Searches for a role
Usage
#set($apiListResponse = $core_v2_role.Find($matchText))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
matchText | string | Match Text | Required |
Return Type
Get
Gets a role
Usage
#set($roleResponse = $core_v2_role.Get($roleId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
roleId | int | Role Id | Required |
Return Type
Get
Gets a role
Usage
#set($roleResponse = $core_v2_role.Get($application, $id, $roleId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
application | string | Application | Required | ||
id | int? | Id | Required | ||
roleId | int | Role Id | Required |
Return Type
Get
Gets a role
Usage
#set($roleResponse = $core_v2_role.Get($application, $id, $roleId, "%{Include = $includeArg, IncludePermissions = $includePermissionsArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
application | string | Application | Required | ||
id | int? | Id | Required | ||
roleId | int | Role Id | Required | ||
Include | string | Include | Optional | denied, granted | |
IncludePermissions | bool | Include Permissions | Optional |
Return Type
List
Lists roles
Usage
#set($pagedListResponse = $core_v2_role.List())
Return Type
List
Lists roles for an application
Usage
#set($pagedListResponse = $core_v2_role.List($application))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
application | string | Application | Required |
Return Type
List
Lists roles
Usage
#set($pagedListResponse = $core_v2_role.List("%{Application = $applicationArg, Id = $idArg, Include = $includeArg, IncludePermissions = $includePermissionsArg, IncludeWithAvatarOnly = $includeWithAvatarOnlyArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, PermissionId = $permissionIdArg, UserId = $userIdArg, Username = $usernameArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
Application | string | Application | Optional | ||
Id | int | Id | Optional | ||
Include | string | Include | Optional | denied, granted, user | |
IncludePermissions | bool | Include Permissions | Optional | ||
IncludeWithAvatarOnly | bool | Will only return roles that have avatars. For use with include=user only. | Optional | ||
PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
PermissionId | string | Permission Id | Optional | ||
UserId | int | Either UserId or Username are required when using include=user | Optional | ||
Username | string | Either UserId or Username are required when using include=user | Optional |
Return Type
Update
Updates a role
Usage
#set($roleResponse = $core_v2_role.Update($roleId, $name, $description))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
roleId | int | Role Id | Required | ||
name | string | Name | Required | ||
description | string | Description | Required |
Return Type
Update
Updates a role
Usage
#set($roleResponse = $core_v2_role.Update($roleId, $name, $description, "%{GroupId = $groupIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
roleId | int | Role Id | Required | ||
name | string | Name | Required | ||
description | string | Description | Required | ||
GroupId | int | Group Id | Optional |