Definition

The "List Users by Project" action retrieves a list of users associated with a specific Jira project based on the provided Project Key. This action is useful for identifying team members involved in a project, managing access, or automating project-related workflows. It provides detailed user information such as Account ID, Display Name, Email Address, Time Zone, and Locale, helping teams efficiently manage their resources and permissions.

Example Use Cases

1. Retrieve Project Team Members

Quickly fetch a list of users working on a specific Jira project to identify team members and their roles.

2. Automate Access Management

Use the retrieved user list to grant or revoke access to other integrated tools based on project assignments.

3. Monitor User Activity

Extract and analyze user details (such as time zone and active status) to track project participation and team availability.

4. Assign Issues Based on Team Members

Use the user list to automate issue assignment workflows, ensuring tasks are allocated to the right people in the project.

5. Generate Reports for Project Teams

Compile lists of project members for reporting, auditing, or compliance purposes.

Inputs

1. Connection

Establishes authentication with your Jira instance to enable secure data retrieval. You must set up a valid connection before using this action.

2. Jira Cloud

The unique identifier for your Jira Cloud instance. It is used to connect and authenticate with Jira. You can select it from the list after establishing your connection.

3. Project Key

A unique identifier for the Jira project. This key is used to retrieve users associated with the project. You can find the Project Key in the Jira URL (e.g., in https://your-domain.atlassian.net/projects/CHEF, "CHEF" is the Project Key). Alternatively, the key can be obtained from the outputs of actions such as Create Project, Update Project, or List Projects.

Step-by-Step Guide

Follow these steps to use the List Users by Project action in a workflow:

Step 1: Establish a Connection

Ensure you have a valid connection to your Jira Cloud instance.
If not already connected, set up authentication by selecting your Jira account.

Step 2: Select the Jira Cloud Instance

Choose the Jira Cloud instance from the available list.
This identifies the specific Jira environment where the project exists.

Step 3: Provide the Project Key

Enter the Project Key manually or retrieve it from a previous step.
You can also extract it from the Jira URL or use outputs from actions like Create Project, Update Project, or List Projects.

Step 4: Execute the Flow

Once all fields are filled, run the flow.
The system will fetch and return the list of users associated with the specified project.

Step 5: Utilize the Output Data

The action returns a list of user details, including Account ID, Account Type, Email Address, Display Name, Time Zone, Locale, and Active Status.
You can use this data for assigning tasks, sending notifications, or managing user permissions within Jira.

Outputs

The List Users by Project action returns a list of users associated with the specified Jira project. Below are the details of the output fields:

Account ID – A unique identifier for the Jira user.
Account Type – Specifies whether the user is an Atlassian account user or an app user.
Email Address – The registered email address of the user (may be restricted due to privacy settings).
Display Name – The full name of the user as it appears in Jira.
Time Zone – The time zone set in the user’s Jira profile.
Locale – The language and regional settings of the user’s Jira account.
Active – A boolean (true or false) indicating whether the user is currently active in Jira.

This output can be used to manage user assignments, send notifications, or verify project team members.

Example Scenario

A project manager needs to assign tasks in Jira but wants to ensure they are only assigning issues to active team members. By using the List Users by Project action, they can retrieve a list of all users associated with a specific Jira project, including their active status and email addresses. This helps them verify team availability before making assignments, ensuring smooth workflow management.