Cmdlets for Jira

Build 25.0.9434

RoleActors

Manages default role actors, who are automatically assigned to roles when new projects are created.

Select

The cmdlet will use the Jira API to process filters that refer to RoleId while the rest of the filter is executed client side within the cmdlet. The Jira APIs support filters using the equals (=) and IN operator with RoleId.

For example, the following queries are processed server side:

Retrieve all the default actors for all roles:

SELECT * FROM RoleActors

Retrieve all the default actors for a specific role:

SELECT * FROM RoleActors WHERE RoleId = '10002'

Insert

Cloud

Add a user as a default actor to a role by specifying the user's account Id.

INSERT INTO RoleActors (ActorUserAccountId, RoleId) VALUES ('63acbf336f068efec8f6e0c3', '10326')

Add a group as a default actor to a role by either specifying the group's Id or name.

INSERT INTO RoleActors (ActorGroupGroupId, RoleId) VALUES ('ad8da7e1-7b66-408e-a61c-c4c8383ca5d1', '10326')

INSERT INTO RoleActors (ActorGroupName, RoleId) VALUES ('testGroupName', '10326')

Server

Add a user as a default actor to a role by specifying the user's key.

INSERT INTO RoleActors (RoleId, UserKey) VALUES ('10102', 'JIRAUSER10001')

Add a group as a default actor to a role by specifying the group's name.

INSERT INTO RoleActors (RoleId, GroupName) VALUES ('10102', 'test-group')

Delete

Cloud

Delete a default actor from a role by specifying the RoleId and the user's account Id, the group's name or the group's Id.

DELETE FROM RoleActors WHERE RoleId = '10326' AND ActorUserAccountId = '63acbf336f068efec8f6e0c3' 

DELETE FROM RoleActors WHERE RoleId = '10325' AND ActorGroupName = 'Developers' 

DELETE FROM RoleActors WHERE RoleId = '10325' AND ActorGroupGroupId = '6dd7f7e1-77f0-4cd1-b8e1-a069830a8f1d' 

Server

Delete a default actor from a role by specifying the user's key or the group's name.

DELETE FROM RoleActors WHERE RoleId = '10102' AND UserKey = 'JIRAUSER10001'

DELETE FROM RoleActors WHERE RoleId = '10102' AND GroupName = 'test-group'

Columns

Name Type ReadOnly References SupportedOperators Platform Description
Id [KEY] Long False Common

The unique identifier assigned to the role actor, used to distinguish users or groups associated with a Jira project role.

DisplayName String False Common

The display name of the user or group associated with the project role. This can differ based on the user's privacy settings.

Type String False Common

The type of role actor, such as 'atlassian-user-role-actor' for users or 'atlassian-group-role-actor' for groups.

AvatarUrl String False Common

The URL to the avatar image representing the user or group in the UI.

ActorUserAccountId String False

Users.AccountId

Cloud

The Atlassian account ID of the user associated with the project role. This ID uniquely identifies the user across all Atlassian products.

ActorGroupName String False

Groups.Name

Cloud

The name of the group associated with the project role. Since group names can change, group IDs are recommended for stable identification.

ActorGroupDisplayName String False Cloud

The human-readable display name of the group that acts in the role.

ActorGroupGroupId String False

Groups.Id

Cloud

The stable ID of the group associated with the project role.

Name String False Server

The name of the Jira role that this actor is assigned to, such as 'Developers' or 'Administrators'.

RoleId Long False

Roles.Id

=,IN Common

The unique identifier for the Jira role that the actor is assigned to.

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
UserKey String

Used only on Jira Server. The key of the user to be inserted or removed from the project role.

GroupName String

Used only on Jira Server. The name of the group to be inserted or removed from the project role.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434