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
Role
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
Role
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
Role
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
Role
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
AdditionalInfo
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 | | |
| UserId | int | User Id | Optional | | |
| Username | string | Username | Optional | | |
Return Type
AdditionalInfo
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
ApiList<Role>
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
Role
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 | | |
| IncludePermissions | bool | Include Permissions | Optional | | |
Return Type
Role
List
Lists roles
Usage
#set($apiListResponse = $core_v2_role.List())
Return Type
ApiList<Role>
List
Lists roles for an application
Usage
#set($apiListResponse = $core_v2_role.List($application))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| application | string | Application | Required | | |
Return Type
ApiList<Role>
List
Lists roles
Usage
#set($apiListResponse = $core_v2_role.List("%{Application = $applicationArg, Id = $idArg, Include = $includeArg, IncludePermissions = $includePermissionsArg, 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 | | |
| 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
ApiList<Role>
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
Role
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 | | |
Return Type
Role