> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# jira-users
> Jira Users - find and look up users, groups, and permissions
**Server path:** `/jira-users` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ----------------------------------------------------------------------- | ------------------------------- |
| [`jira_users_find_assignable_users`](#jira_users_find_assignable_users) | Find users assignable to issues |
| [`jira_users_find_users`](#jira_users_find_users) | Find users |
| [`jira_users_find_users_and_groups`](#jira_users_find_users_and_groups) | Find users and groups |
| [`jira_users_find_users_for_picker`](#jira_users_find_users_for_picker) | Find users for picker |
| [`jira_users_get_bulk_permissions`](#jira_users_get_bulk_permissions) | Get bulk permissions |
| [`jira_users_get_current_user`](#jira_users_get_current_user) | Get current user |
| [`jira_users_get_my_permissions`](#jira_users_get_my_permissions) | Get my permissions |
| [`jira_users_get_user`](#jira_users_get_user) | Get user |
***
## jira\_users\_find\_assignable\_users
Find users assignable to issues
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `query` | string | No | — | A query string that is matched against user attributes, such as `displayName`, and `emailAddress`, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a `displayName` of *John Smith* and a user with an `emailAddress` of *[johnson@example.com](mailto:johnson@example.com)*. Required, unless `username` or `accountId` is specified. |
| `sessionId` | string | No | — | The sessionId of this request. SessionId is the same until the assignee is set. |
| `username` | string | No | — | This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. |
| `accountId` | string | No | — | A query string that is matched exactly against user `accountId`. Required, unless `query` is specified. |
| `project` | string | No | — | The project ID or project key (case sensitive). Required, unless `issueKey` or `issueId` is specified. |
| `issueKey` | string | No | — | The key of the issue. Required, unless `issueId` or `project` is specified. |
| `issueId` | string | No | — | The ID of the issue. Required, unless `issueKey` or `project` is specified. |
| `startAt` | integer | No | — | The index of the first item to return in a page of results (page offset). |
| `maxResults` | integer | No | — | The maximum number of items to return. This operation may return less than the maximum number of items even if more are available. The operation fetches users up to the maximum and then, from the fetched users, returns only the users that can be assigned to the issue. |
| `actionDescriptorId` | integer | No | — | The ID of the transition. |
| `recommend` | boolean | No | — | The recommend value |
| `accountType` | string\[] | No | — | Account Type |
| `appType` | string\[] | No | — | App Type |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"query": {
"type": "string",
"description": "A query string that is matched against user attributes, such as `displayName`, and `emailAddress`, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a `displayName` of *John Smith* and a user with an `emailAddress` of *johnson@example.com*. Required, unless `username` or `accountId` is specified."
},
"sessionId": {
"type": "string",
"description": "The sessionId of this request. SessionId is the same until the assignee is set."
},
"username": {
"type": "string",
"description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
"accountId": {
"type": "string",
"description": "A query string that is matched exactly against user `accountId`. Required, unless `query` is specified."
},
"project": {
"type": "string",
"description": "The project ID or project key (case sensitive). Required, unless `issueKey` or `issueId` is specified."
},
"issueKey": {
"type": "string",
"description": "The key of the issue. Required, unless `issueId` or `project` is specified."
},
"issueId": {
"type": "string",
"description": "The ID of the issue. Required, unless `issueKey` or `project` is specified."
},
"startAt": {
"type": "integer",
"description": "The index of the first item to return in a page of results (page offset)."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of items to return. This operation may return less than the maximum number of items even if more are available. The operation fetches users up to the maximum and then, from the fetched users, returns only the users that can be assigned to the issue."
},
"actionDescriptorId": {
"type": "integer",
"description": "The ID of the transition."
},
"recommend": {
"type": "boolean",
"description": "The recommend value"
},
"accountType": {
"type": "array",
"items": {
"type": "string"
},
"description": "Account Type"
},
"appType": {
"type": "array",
"items": {
"type": "string"
},
"description": "App Type"
}
},
"required": [
"PCID"
]
}
```
***
## jira\_users\_find\_users
Find users
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `query` | string | No | — | A query string that is matched against user attributes ( `displayName`, and `emailAddress`) to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a `displayName` of *John Smith* and a user with an `emailAddress` of *[johnson@example.com](mailto:johnson@example.com)*. Required, unless `accountId` or `property` is specified. |
| `username` | string | No | — | The username value |
| `accountId` | string | No | — | A query string that is matched exactly against a user `accountId`. Required, unless `query` or `property` is specified. |
| `startAt` | integer | No | — | The index of the first item to return in a page of filtered results (page offset). |
| `maxResults` | integer | No | — | The maximum number of items to return per page. |
| `property` | string | No | — | A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of `nested` from `{"something":{"nested":1,"other":2}}` use `thepropertykey.something.nested=1`. Required, unless `accountId` or `query` is specified. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"query": {
"type": "string",
"description": "A query string that is matched against user attributes ( `displayName`, and `emailAddress`) to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a `displayName` of *John Smith* and a user with an `emailAddress` of *johnson@example.com*. Required, unless `accountId` or `property` is specified."
},
"username": {
"type": "string",
"description": "The username value"
},
"accountId": {
"type": "string",
"description": "A query string that is matched exactly against a user `accountId`. Required, unless `query` or `property` is specified."
},
"startAt": {
"type": "integer",
"description": "The index of the first item to return in a page of filtered results (page offset)."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of items to return per page."
},
"property": {
"type": "string",
"description": "A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of `nested` from `{\"something\":{\"nested\":1,\"other\":2}}` use `thepropertykey.something.nested=1`. Required, unless `accountId` or `query` is specified."
}
},
"required": [
"PCID"
]
}
```
***
## jira\_users\_find\_users\_and\_groups
Find users and groups
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `query` | string | Yes | — | The search string. |
| `maxResults` | integer | No | — | The maximum number of items to return in each list. |
| `showAvatar` | boolean | No | — | Whether the user avatar should be returned. If an invalid value is provided, the default value is used. |
| `fieldId` | string | No | — | The custom field ID of the field this request is for. |
| `projectId` | string\[] | No | — | The ID of a project that returned users and groups must have permission to view. To include multiple projects, provide an ampersand-separated list. For example, `projectId=10000&projectId=10001`. This parameter is only used when `fieldId` is present. |
| `issueTypeId` | string\[] | No | — | The ID of an issue type that returned users and groups must have permission to view. To include multiple issue types, provide an ampersand-separated list. For example, `issueTypeId=10000&issueTypeId=10001`. Special values, such as `-1` (all standard issue types) and `-2` (all subtask issue types), are supported. This parameter is only used when `fieldId` is present. |
| `avatarSize` | string | No | — | The size of the avatar to return. If an invalid value is provided, the default value is used. |
| `caseInsensitive` | boolean | No | — | Whether the search for groups should be case insensitive. |
| `excludeConnectAddons` | boolean | No | — | Whether Connect app users and groups should be excluded from the search results. If an invalid value is provided, the default value is used. |
| `includeAiAgents` | boolean | No | — | Whether AI Agents should be included in the search results. If an invalid value is provided, the default value is used. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"query": {
"type": "string",
"description": "The search string."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of items to return in each list."
},
"showAvatar": {
"type": "boolean",
"description": "Whether the user avatar should be returned. If an invalid value is provided, the default value is used."
},
"fieldId": {
"type": "string",
"description": "The custom field ID of the field this request is for."
},
"projectId": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ID of a project that returned users and groups must have permission to view. To include multiple projects, provide an ampersand-separated list. For example, `projectId=10000&projectId=10001`. This parameter is only used when `fieldId` is present."
},
"issueTypeId": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ID of an issue type that returned users and groups must have permission to view. To include multiple issue types, provide an ampersand-separated list. For example, `issueTypeId=10000&issueTypeId=10001`. Special values, such as `-1` (all standard issue types) and `-2` (all subtask issue types), are supported. This parameter is only used when `fieldId` is present."
},
"avatarSize": {
"type": "string",
"description": "The size of the avatar to return. If an invalid value is provided, the default value is used.",
"enum": [
"xsmall",
"xsmall@2x",
"xsmall@3x",
"small",
"small@2x",
"small@3x",
"medium",
"medium@2x",
"medium@3x",
"large",
"large@2x",
"large@3x",
"xlarge",
"xlarge@2x",
"xlarge@3x",
"xxlarge",
"xxlarge@2x",
"xxlarge@3x",
"xxxlarge",
"xxxlarge@2x",
"xxxlarge@3x"
]
},
"caseInsensitive": {
"type": "boolean",
"description": "Whether the search for groups should be case insensitive."
},
"excludeConnectAddons": {
"type": "boolean",
"description": "Whether Connect app users and groups should be excluded from the search results. If an invalid value is provided, the default value is used."
},
"includeAiAgents": {
"type": "boolean",
"description": "Whether AI Agents should be included in the search results. If an invalid value is provided, the default value is used."
}
},
"required": [
"PCID",
"query"
]
}
```
***
## jira\_users\_find\_users\_for\_picker
Find users for picker
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `query` | string | Yes | — | A query string that is matched against user attributes, such as `displayName`, and `emailAddress`, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a `displayName` of *John Smith* and a user with an `emailAddress` of *[johnson@example.com](mailto:johnson@example.com)*. |
| `maxResults` | integer | No | — | The maximum number of items to return. The total number of matched users is returned in `total`. |
| `showAvatar` | boolean | No | — | Include the URI to the user's avatar. |
| `exclude` | string\[] | No | — | This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. |
| `excludeAccountIds` | string\[] | No | — | A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, `excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5`. Cannot be provided with `exclude`. |
| `avatarSize` | string | No | — | Avatar Size |
| `excludeConnectUsers` | boolean | No | — | Exclude Connect Users |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"query": {
"type": "string",
"description": "A query string that is matched against user attributes, such as `displayName`, and `emailAddress`, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a `displayName` of *John Smith* and a user with an `emailAddress` of *johnson@example.com*."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of items to return. The total number of matched users is returned in `total`."
},
"showAvatar": {
"type": "boolean",
"description": "Include the URI to the user's avatar."
},
"exclude": {
"type": "array",
"items": {
"type": "string"
},
"description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
"excludeAccountIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, `excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5`. Cannot be provided with `exclude`."
},
"avatarSize": {
"type": "string",
"description": "Avatar Size"
},
"excludeConnectUsers": {
"type": "boolean",
"description": "Exclude Connect Users"
}
},
"required": [
"PCID",
"query"
]
}
```
***
## jira\_users\_get\_bulk\_permissions
Get bulk permissions
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | --------- | -------- | ------- | ------------------------------------------------------------------- |
| `accountId` | string | No | — | The account ID of a user. |
| `globalPermissions` | string\[] | No | — | Global permissions to look up. |
| `projectPermissions` | object\[] | No | — | Project permissions with associated projects and issues to look up. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "The account ID of a user."
},
"globalPermissions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Global permissions to look up."
},
"projectPermissions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"issues": {
"type": "array",
"items": {
"type": "integer"
},
"description": "List of issue IDs."
},
"permissions": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of project permissions."
},
"projects": {
"type": "array",
"items": {
"type": "integer"
},
"description": "List of project IDs."
}
},
"required": [
"permissions"
]
},
"description": "Project permissions with associated projects and issues to look up."
}
},
"required": [
"PCID"
]
}
```
***
## jira\_users\_get\_current\_user
Get current user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `expand` | string | No | — | Use expand to include additional information about user in the response. This parameter accepts a comma-separated list. Expand options include: \* `groups` Returns all groups, including nested groups, the user belongs to. \* `applicationRoles` Returns the application roles the user is assigned to. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information about user in the response. This parameter accepts a comma-separated list. Expand options include: * `groups` Returns all groups, including nested groups, the user belongs to. * `applicationRoles` Returns the application roles the user is assigned to."
}
},
"required": [
"PCID"
]
}
```
***
## jira\_users\_get\_my\_permissions
Get my permissions
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `projectKey` | string | No | — | The key of project. Ignored if `projectId` is provided. |
| `projectId` | string | No | — | The ID of project. |
| `issueKey` | string | No | — | The key of the issue. Ignored if `issueId` is provided. |
| `issueId` | string | No | — | The ID of the issue. |
| `permissions` | string | No | — | A list of permission keys. (Required) This parameter accepts a comma-separated list. To get the list of available permissions, use Get all permissions. |
| `projectUuid` | string | No | — | Project Uuid |
| `projectConfigurationUuid` | string | No | — | Project Configuration Uuid |
| `commentId` | string | No | — | The ID of the comment. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectKey": {
"type": "string",
"description": "The key of project. Ignored if `projectId` is provided."
},
"projectId": {
"type": "string",
"description": "The ID of project."
},
"issueKey": {
"type": "string",
"description": "The key of the issue. Ignored if `issueId` is provided."
},
"issueId": {
"type": "string",
"description": "The ID of the issue."
},
"permissions": {
"type": "string",
"description": "A list of permission keys. (Required) This parameter accepts a comma-separated list. To get the list of available permissions, use [Get all permissions](#api-rest-api-3-permissions-get)."
},
"projectUuid": {
"type": "string",
"description": "Project Uuid"
},
"projectConfigurationUuid": {
"type": "string",
"description": "Project Configuration Uuid"
},
"commentId": {
"type": "string",
"description": "The ID of the comment."
}
},
"required": [
"PCID"
]
}
```
***
## jira\_users\_get\_user
Get user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accountId` | string | No | — | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required. |
| `username` | string | No | — | This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide) for details. |
| `key` | string | No | — | This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide) for details. |
| `expand` | string | No | — | Use expand to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include: \* `groups` includes all groups and nested groups to which the user belongs. \* `applicationRoles` includes details of all the applications to which the user has access. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required."
},
"username": {
"type": "string",
"description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide) for details."
},
"key": {
"type": "string",
"description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide) for details."
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include: * `groups` includes all groups and nested groups to which the user belongs. * `applicationRoles` includes details of all the applications to which the user has access."
}
},
"required": [
"PCID"
]
}
```