ProjectRoleActors
Manages role assignments within projects. Retrieves and updates users and groups assigned to project roles.
Select
The add-in will use the Jira API to process filters that refer to ProjectId, ProjectKey and RoleId while the rest of the filter is executed client side within the add-in. The Jira APIs support filters using the equals (=) and IN operator with ProjectId, ProjectKey and RoleId. Note that either ProjectId, ProjectKey or RoleId must be specified with a comparison type of equals (=) for SELECT SQL statement.
For example, the following queries are processed server side:
Retrieve all actors for a specific project:
SELECT * FROM ProjectRoleActors WHERE ProjectId = '10650'
SELECT * FROM ProjectRoleActors WHERE ProjectKey = 'MYP'
Retrieve all actors for a specific role in all projects:
SELECT * FROM ProjectRoleActors WHERE RoleId = '10329'
Retrieve all actors for a specific project:
SELECT * FROM ProjectRoleActors WHERE RoleId = '10329' AND ProjectId = '10650'
Retrieve all actors for specific projects:
SELECT * FROM ProjectRoleActors WHERE RoleId = '10329' AND ProjectId IN ('10650', '10651', '10652')
Retrieve all actors for specific roles in a project:
SELECT * FROM ProjectRoleActors WHERE RoleId IN ('10329', '10330', '10331') AND ProjectId = '10650'
Insert
Cloud
Add a user as an actor to a role in a specific project by specifying the user's account Id.
INSERT INTO ProjectRoleActors (ProjectId, RoleId, ActorUserAccountId) VALUES ('10650', '10329', '63acbf336f068efec8f6e0c3')
Add a group as an actor to a role in a specific project by either specifying the group's Id or name.
INSERT INTO ProjectRoleActors (ProjectId, RoleId, ActorGroupGroupId) VALUES ('10650', '10329', '0eed15e3-80cc-41d0-ba1a-b408658caf4d')
INSERT INTO ProjectRoleActors (ProjectId, RoleId, ActorGroupName) VALUES ('10650', '10329', 'JohnTest1')
Server
Add a user as an actor to a role by specifying the project, role and user's name.
INSERT INTO ProjectRoleActors (ProjectId, RoleId, UserName) VALUES ('10000', '10101', 'myuser')
Add a group as an actor to a role by specifying the project, role and group's name.
INSERT INTO ProjectRoleActors (ProjectId, RoleId, GroupName) VALUES ('10000', '10101', 'test-group')
Delete
Cloud
Delete an actor from a role by specifying the project, role and the user's account Id, the group's name or the group's Id.
DELETE FROM ProjectRoleActors WHERE ProjectId = '10650' AND RoleId = '10329' AND ActorUserAccountId = '63acbf336f068efec8f6e0c3'
DELETE FROM ProjectRoleActors WHERE ActorGroupGroupId = '0eed15e3-80cc-41d0-ba1a-b408658caf4d' AND ProjectId = '10650' AND RoleId = '10330'
DELETE FROM ProjectRoleActors WHERE ActorGroupName = 'JohnTest1' AND ProjectId = '10650' AND RoleId = '10330'
Server
Delete a default actor from a role by specifying the user's name or the group's name.
DELETE FROM ProjectRoleActors WHERE ProjectId = '10000' AND RoleId = '10101' AND UserName = 'myuser'
DELETE FROM ProjectRoleActors WHERE ProjectId = '10000' AND RoleId = '10101' AND GroupName = 'test-group'
Columns
| Name | Type | ReadOnly | References | SupportedOperators | Platform | Description |
| Id [KEY] | Long | False | Common |
A unique identifier for the role actor, which represents either a user or a group assigned to a project role. | ||
| DisplayName | String | False | Common |
The display name of the role actor. For users, this can reflect privacy settings and return a masked or alternative value instead of the actual name. | ||
| Type | String | False | Common |
The type of role actor, such as 'atlassian-user-role-actor' for users or 'atlassian-group-role-actor' for groups. | ||
| Name | String | False | Server |
The name of the project role that this actor is associated with. | ||
| AvatarUrl | String | False | Common |
The URL to the avatar image representing the role actor (user or group). | ||
| ActorUserAccountId | String | False | Cloud |
The unique account ID of the user acting in the role, consistent across all Atlassian products. | ||
| ActorGroupName | String | False | Cloud |
The name of the group acting in the role. As group names can change, groupId is recommended for reliable identification. | ||
| ActorGroupDisplayName | String | False | Cloud |
The human-readable display name of the group acting in the role. | ||
| ActorGroupGroupId | String | False | Cloud |
The ID of the group associated with the project role. | ||
| RoleId | Long | False |
Roles.Id | =,IN | Common |
The ID of the project role that the actor is assigned to. |
| ProjectId | Integer | False |
Projects.Id | =,IN | Common |
The numeric ID of the project in which the role actor is defined. |
| ProjectKey | String | False |
Projects.Key | =,IN | Common |
The unique key of the project associated with the project role. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| UserName | String |
Used in Server platform only for Insert/Delete operations. Specifies the username of the user to be added or removed from the project role. |
| GroupName | String |
Used in Server platform only for Insert/Delete operations. Specifies the name of the group to be added or removed from the project role. |