user
bulk-get
Bulk get users
Returns a paginated list of the users specified by one or more account IDs.
Permissions required: Permission to access Jira.
GET /rest/api/3/user/bulk
| Flag | Type | Required | Description |
|---|---|---|---|
--accountId | string | No | The account ID of a user. To specify multiple users, pass multiple accountId parameters. For example, accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5. |
--key | string | No | This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
--maxResults | string | No | The maximum number of items to return per page. |
--startAt | string | No | The index of the first item to return in a page of results (page offset). |
--username | string | No | This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
Example:
jr user bulk-getbulk-get-users-migration
Get account IDs for users
Returns the account IDs for the users specified in the key or username parameters. Note that multiple key or username parameters can be specified.
Permissions required: Permission to access Jira.
GET /rest/api/3/user/bulk/migration
| Flag | Type | Required | Description |
|---|---|---|---|
--key | string | No | Key of a user. To specify multiple users, pass multiple copies of this parameter. For example, key=fred&key=barney. Required if username isn't provided. Cannot be provided if username is present. |
--maxResults | string | No | The maximum number of items to return per page. |
--startAt | string | No | The index of the first item to return in a page of results (page offset). |
--username | string | No | Username of a user. To specify multiple users, pass multiple copies of this parameter. For example, username=fred&username=barney. Required if key isn't provided. Cannot be provided if key is present. |
Example:
jr user bulk-get-users-migrationcreate
Create user
Creates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is available this resource will be deprecated.
Note: This API does not support Forge apps.
If the user exists and has access to Jira, the operation returns a 201 status. If the user exists but does not have access to Jira, the operation returns a 400 status.
Permissions required: Administer Jira global permission. The caller has to be an organization admin.
POST /rest/api/3/user
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
Example:
jr user createdelete-property
Delete user property
Deletes a property from a user.
Note: This operation does not access the user properties created and maintained in Jira.
Permissions required:
- Administer Jira global permission, to delete a property from any user.
- Access to Jira, to delete a property from the calling user's record.
DELETE /rest/api/3/user/properties/{propertyKey}
| Flag | Type | Required | Description |
|---|---|---|---|
--accountId | string | No | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
--propertyKey | string | Yes | The key of the user's property. |
--userKey | string | No | This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
--username | string | No | This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
Example:
jr user delete-property --propertyKey <propertyKey>find
Find users
Returns a list of active users that match the search string and property.
This operation first applies a filter to match the search string and property, and then takes the filtered users in the range defined by startAt and maxResults, up to the thousandth user. To get all the users who match the search string and property, use Get all users and filter the records in your code.
This operation can be accessed anonymously.
Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.
Permissions required: Browse users and groups global permission. Anonymous calls or calls by users without the required permission return empty search results.
GET /rest/api/3/user/search
| Flag | Type | Required | Description |
|---|---|---|---|
--accountId | string | No | A query string that is matched exactly against a user accountId. Required, unless query or property is specified. |
--maxResults | string | 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. |
--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. Required, unless accountId or property is specified. |
--startAt | string | No | The index of the first item to return in a page of filtered results (page offset). |
--username | string | No |
Example:
jr user findfind-assignable
Find users assignable to issues
Returns a list of users that can be assigned to an issue. Use this operation to find the list of users who can be assigned to:
- a new issue, by providing the
projectKeyOrId. - an updated issue, by providing the
issueKeyorissueId. - to an issue during a transition (workflow action), by providing the
issueKeyorissueIdand the transition id inactionDescriptorId. You can obtain the IDs of an issue's valid transitions using thetransitionsoption in theexpandparameter of Get issue.
In all these cases, you can pass an account ID to determine if a user can be assigned to an issue. The user is returned in the response if they can be assigned to the issue or issue transition.
This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that can be assigned the issue. This means the operation usually returns fewer users than specified in maxResults. To get all the users who can be assigned the issue, use Get all users and filter the records in your code.
Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.
Permissions required: Browse users and groups global permission or Assign issues project permission
GET /rest/api/3/user/assignable/search
| Flag | Type | Required | Description |
|---|---|---|---|
--accountId | string | No | A query string that is matched exactly against user accountId. Required, unless query is specified. |
--accountType | string | No | |
--actionDescriptorId | string | No | The ID of the transition. |
--appType | string | No | |
--issueId | string | No | The ID of the issue. Required, unless issueKey or project is specified. |
--issueKey | string | No | The key of the issue. Required, unless issueId or project is specified. |
--maxResults | string | 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. |
--project | string | No | The project ID or project key (case sensitive). Required, unless issueKey or issueId is specified. |
--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. Required, unless username or accountId is specified. |
--recommend | string | No | |
--sessionId | string | No | The sessionId of this request. SessionId is the same until the assignee is set. |
--startAt | string | No | The index of the first item to return in a page of results (page offset). |
--username | string | No | This parameter is no longer available. See the deprecation notice for details. |
Example:
jr user find-assignablefind-bulk-assignable
Find users assignable to projects
Returns a list of users who can be assigned issues in one or more projects. The list may be restricted to users whose attributes match a string.
This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that can be assigned issues in the projects. This means the operation usually returns fewer users than specified in maxResults. To get all the users who can be assigned issues in the projects, use Get all users and filter the records in your code.
Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.
This operation can be accessed anonymously.
Permissions required: Browse Projects project permission for each project specified in projectKeys.
GET /rest/api/3/user/assignable/multiProjectSearch
| Flag | Type | Required | Description |
|---|---|---|---|
--accountId | string | No | A query string that is matched exactly against user accountId. Required, unless query is specified. |
--maxResults | string | No | The maximum number of items to return per page. |
--projectKeys | string | No | A list of project keys (case sensitive). This parameter accepts a comma-separated list. |
--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. Required, unless accountId is specified. |
--startAt | string | No | The index of the first item to return in a page of results (page offset). |
--username | string | No | This parameter is no longer available. See the deprecation notice for details. |
Example:
jr user find-bulk-assignablefind-by-query
Find users by query
Finds users with a structured query and returns a paginated list of user details.
This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the structured query. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the structured query, use Get all users and filter the records in your code.
Permissions required: Browse users and groups global permission.
The query statements are:
is assignee of PROJReturns the users that are assignees of at least one issue in project PROJ.is assignee of (PROJ-1, PROJ-2)Returns users that are assignees on the issues PROJ-1 or PROJ-2.is reporter of (PROJ-1, PROJ-2)Returns users that are reporters on the issues PROJ-1 or PROJ-2.is watcher of (PROJ-1, PROJ-2)Returns users that are watchers on the issues PROJ-1 or PROJ-2.is voter of (PROJ-1, PROJ-2)Returns users that are voters on the issues PROJ-1 or PROJ-2.is commenter of (PROJ-1, PROJ-2)Returns users that have posted a comment on the issues PROJ-1 or PROJ-2.is transitioner of (PROJ-1, PROJ-2)Returns users that have performed a transition on issues PROJ-1 or PROJ-2.[propertyKey].entity.property.path is "property value"Returns users with the entity property value. For example, if user propertylocationis set to value{"office": {"country": "AU", "city": "Sydney"}}, then it's possible to use[location].office.city is "Sydney"to match the user.
The list of issues can be extended as needed, as in (PROJ-1, PROJ-2, ... PROJ-n). Statements can be combined using the AND and OR operators to form more complex queries. For example:
is assignee of PROJ AND [propertyKey].entity.property.path is "property value"
GET /rest/api/3/user/search/query
| Flag | Type | Required | Description |
|---|---|---|---|
--maxResults | string | No | The maximum number of items to return per page. |
--query | string | No | The search query. |
--startAt | string | No | The index of the first item to return in a page of results (page offset). |
Example:
jr user find-by-queryfind-for-picker
Find users for picker
Returns a list of users whose attributes match the query term. The returned object includes the html field where the matched query term is highlighted with the HTML strong tag. A list of account IDs can be provided to exclude users from the results.
This operation takes the users in the range defined by maxResults, up to the thousandth user, and then returns only the users from that range that match the query term. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the query term, use Get all users and filter the records in your code.
Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.
This operation can be accessed anonymously.
Permissions required: Browse users and groups global permission. Anonymous calls and calls by users without the required permission return search results for an exact name match only.
GET /rest/api/3/user/picker
| Flag | Type | Required | Description |
|---|---|---|---|
--avatarSize | string | No | |
--exclude | string | No | This parameter is no longer available. See the deprecation notice 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. |
--excludeConnectUsers | string | No | |
--maxResults | string | No | The maximum number of items to return. The total number of matched users is returned in total. |
--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. |
--showAvatar | string | No | Include the URI to the user's avatar. |
Example:
jr user find-for-pickerfind-keys-by-query
Find user keys by query
Finds users with a structured query and returns a paginated list of user keys.
This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the structured query. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the structured query, use Get all users and filter the records in your code.
Permissions required: Browse users and groups global permission.
The query statements are:
is assignee of PROJReturns the users that are assignees of at least one issue in project PROJ.is assignee of (PROJ-1, PROJ-2)Returns users that are assignees on the issues PROJ-1 or PROJ-2.is reporter of (PROJ-1, PROJ-2)Returns users that are reporters on the issues PROJ-1 or PROJ-2.is watcher of (PROJ-1, PROJ-2)Returns users that are watchers on the issues PROJ-1 or PROJ-2.is voter of (PROJ-1, PROJ-2)Returns users that are voters on the issues PROJ-1 or PROJ-2.is commenter of (PROJ-1, PROJ-2)Returns users that have posted a comment on the issues PROJ-1 or PROJ-2.is transitioner of (PROJ-1, PROJ-2)Returns users that have performed a transition on issues PROJ-1 or PROJ-2.[propertyKey].entity.property.path is "property value"Returns users with the entity property value. For example, if user propertylocationis set to value{"office": {"country": "AU", "city": "Sydney"}}, then it's possible to use[location].office.city is "Sydney"to match the user.
The list of issues can be extended as needed, as in (PROJ-1, PROJ-2, ... PROJ-n). Statements can be combined using the AND and OR operators to form more complex queries. For example:
is assignee of PROJ AND [propertyKey].entity.property.path is "property value"
GET /rest/api/3/user/search/query/key
| Flag | Type | Required | Description |
|---|---|---|---|
--maxResult | string | No | The maximum number of items to return per page. |
--query | string | No | The search query. |
--startAt | string | No | The index of the first item to return in a page of results (page offset). |
Example:
jr user find-keys-by-queryfind-with-all-permissions
Find users with permissions
Returns a list of users who fulfill these criteria:
- their user attributes match a search string.
- they have a set of permissions for a project or issue.
If no search string is provided, a list of all users with the permissions is returned.
This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the search string and have permission for the project or issue. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the search string and have permission for the project or issue, use Get all users and filter the records in your code.
Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.
This operation can be accessed anonymously.
Permissions required:
- Administer Jira global permission, to get users for any project.
- Administer Projects project permission for a project, to get users for that project.
GET /rest/api/3/user/permission/search
| Flag | Type | Required | Description |
|---|---|---|---|
--accountId | string | No | A query string that is matched exactly against user accountId. Required, unless query is specified. |
--issueKey | string | No | The issue key for the issue. |
--maxResults | string | No | The maximum number of items to return per page. |
--permissions | string | No | A comma separated list of permissions. Permissions can be specified as any: |
permission returned by Get all permissions.
custom project permission added by Connect apps.
(deprecated) one of the following:
- ASSIGNABLE_USER
- ASSIGN_ISSUE
- ATTACHMENT_DELETE_ALL
- ATTACHMENT_DELETE_OWN
- BROWSE
- CLOSE_ISSUE
- COMMENT_DELETE_ALL
- COMMENT_DELETE_OWN
- COMMENT_EDIT_ALL
- COMMENT_EDIT_OWN
- COMMENT_ISSUE
- CREATE_ATTACHMENT
- CREATE_ISSUE
- DELETE_ISSUE
- EDIT_ISSUE
- LINK_ISSUE
- MANAGE_WATCHER_LIST
- MODIFY_REPORTER
- MOVE_ISSUE
- PROJECT_ADMIN
- RESOLVE_ISSUE
- SCHEDULE_ISSUE
- SET_ISSUE_SECURITY
- TRANSITION_ISSUE
- VIEW_VERSION_CONTROL
- VIEW_VOTERS_AND_WATCHERS
- VIEW_WORKFLOW_READONLY
- WORKLOG_DELETE_ALL
- WORKLOG_DELETE_OWN
- WORKLOG_EDIT_ALL
- WORKLOG_EDIT_OWN
- WORK_ISSUE | |
--projectKey| string | No | The project key for the project (case sensitive). | |--query| string | No | A query string that is matched against user attributes, such asdisplayNameandemailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with adisplayNameof John Smith and a user with anemailAddressof johnson@example.com. Required, unlessaccountIdis specified. | |--startAt| string | No | The index of the first item to return in a page of results (page offset). | |--username| string | No | This parameter is no longer available. See the deprecation notice for details. |
Example:
jr user find-with-all-permissionsfind-with-browse-permission
Find users with browse permission
Returns a list of users who fulfill these criteria:
- their user attributes match a search string.
- they have permission to browse issues.
Use this resource to find users who can browse:
- an issue, by providing the
issueKey. - any issue in a project, by providing the
projectKey.
This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the search string and have permission to browse issues. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the search string and have permission to browse issues, use Get all users and filter the records in your code.
Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.
This operation can be accessed anonymously.
Permissions required: Browse users and groups global permission. Anonymous calls and calls by users without the required permission return empty search results.
GET /rest/api/3/user/viewissue/search
| Flag | Type | Required | Description |
|---|---|---|---|
--accountId | string | No | A query string that is matched exactly against user accountId. Required, unless query is specified. |
--issueKey | string | No | The issue key for the issue. Required, unless projectKey is specified. |
--maxResults | string | No | The maximum number of items to return per page. |
--projectKey | string | No | The project key for the project (case sensitive). Required, unless issueKey is specified. |
--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. Required, unless accountId is specified. |
--startAt | string | No | The index of the first item to return in a page of results (page offset). |
--username | string | No | This parameter is no longer available. See the deprecation notice for details. |
Example:
jr user find-with-browse-permissionget
Get user
Returns a user.
Privacy controls are applied to the response based on the user's preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.
Permissions required: Browse users and groups global permission.
GET /rest/api/3/user
| Flag | Type | Required | Description |
|---|---|---|---|
--accountId | string | No | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required. |
--expand | string | No | Use expand to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include: |
groupsincludes all groups and nested groups to which the user belongs.applicationRolesincludes details of all the applications to which the user has access. | |--key| string | No | This parameter is no longer available. See the deprecation notice for details. | |--username| string | No | This parameter is no longer available. See the deprecation notice for details. |
Example:
jr user getget-default-columns
Get user default columns
Returns the default issue table columns for the user. If accountId is not passed in the request, the calling user's details are returned.
Permissions required:
- Administer Jira global permission, to get the column details for any user.
- Permission to access Jira, to get the calling user's column details.
GET /rest/api/3/user/columns
| Flag | Type | Required | Description |
|---|---|---|---|
--accountId | string | No | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
--username | string | No | This parameter is no longer available See the deprecation notice for details. |
Example:
jr user get-default-columnsget-email
Get user email
Returns a user's email address regardless of the user's profile visibility settings. For Connect apps, this API is only available to apps approved by Atlassian, according to these guidelines. For Forge apps, this API only supports access via asApp() requests.
GET /rest/api/3/user/email
| Flag | Type | Required | Description |
|---|---|---|---|
--accountId | string | No | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
Example:
jr user get-emailget-email-bulk
Get user email bulk
Returns a user's email address regardless of the user's profile visibility settings. For Connect apps, this API is only available to apps approved by Atlassian, according to these guidelines. For Forge apps, this API only supports access via asApp() requests.
GET /rest/api/3/user/email/bulk
| Flag | Type | Required | Description |
|---|---|---|---|
--accountId | string | No | The account IDs of the users for which emails are required. An accountId is an identifier that uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Note, this should be treated as an opaque identifier (that is, do not assume any structure in the value). |
Example:
jr user get-email-bulkget-groups
Get user groups
Returns the groups to which a user belongs.
Permissions required: Browse users and groups global permission.
GET /rest/api/3/user/groups
| Flag | Type | Required | Description |
|---|---|---|---|
--accountId | string | No | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
--key | string | No | This parameter is no longer available. See the deprecation notice for details. |
--username | string | No | This parameter is no longer available. See the deprecation notice for details. |
Example:
jr user get-groupsget-property
Get user property
Returns the value of a user's property. If no property key is provided Get user property keys is called.
Note: This operation does not access the user properties created and maintained in Jira.
Permissions required:
- Administer Jira global permission, to get a property from any user.
- Access to Jira, to get a property from the calling user's record.
GET /rest/api/3/user/properties/{propertyKey}
| Flag | Type | Required | Description |
|---|---|---|---|
--accountId | string | No | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
--propertyKey | string | Yes | The key of the user's property. |
--userKey | string | No | This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
--username | string | No | This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
Example:
jr user get-property --propertyKey <propertyKey>get-property-keys
Get user property keys
Returns the keys of all properties for a user.
Note: This operation does not access the user properties created and maintained in Jira.
Permissions required:
- Administer Jira global permission, to access the property keys on any user.
- Access to Jira, to access the calling user's property keys.
GET /rest/api/3/user/properties
| Flag | Type | Required | Description |
|---|---|---|---|
--accountId | string | No | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
--userKey | string | No | This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
--username | string | No | This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
Example:
jr user get-property-keysremove
Delete user
Deletes a user. If the operation completes successfully then the user is removed from Jira's user base. This operation does not delete the user's Atlassian account.
Permissions required: Site administration (that is, membership of the site-admin group).
DELETE /rest/api/3/user
| Flag | Type | Required | Description |
|---|---|---|---|
--accountId | string | No | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
--key | string | No | This parameter is no longer available. See the deprecation notice for details. |
--username | string | No | This parameter is no longer available. See the deprecation notice for details. |
Example:
jr user removereset-columns
Reset user default columns
Resets the default issue table columns for the user to the system default. If accountId is not passed, the calling user's default columns are reset.
Permissions required:
- Administer Jira global permission, to set the columns on any user.
- Permission to access Jira, to set the calling user's columns.
DELETE /rest/api/3/user/columns
| Flag | Type | Required | Description |
|---|---|---|---|
--accountId | string | No | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
--username | string | No | This parameter is no longer available. See the deprecation notice for details. |
Example:
jr user reset-columnsset-columns
Set user default columns
Sets the default issue table columns for the user. If an account ID is not passed, the calling user's default columns are set. If no column details are sent, then all default columns are removed.
The parameters for this resource are expressed as HTML form data. For example, in curl:
curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/user/columns?accountId=5b10ac8d82e05b22cc7d4ef5'
Permissions required:
- Administer Jira global permission, to set the columns on any user.
- Permission to access Jira, to set the calling user's columns.
PUT /rest/api/3/user/columns
| Flag | Type | Required | Description |
|---|---|---|---|
--accountId | string | No | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
--body | string | No | request body (JSON string, @file, or - for stdin) |
Example:
jr user set-columnsset-property
Set user property
Sets the value of a user's property. Use this resource to store custom data against a user.
Note: This operation does not access the user properties created and maintained in Jira.
Permissions required:
- Administer Jira global permission, to set a property on any user.
- Access to Jira, to set a property on the calling user's record.
PUT /rest/api/3/user/properties/{propertyKey}
| Flag | Type | Required | Description |
|---|---|---|---|
--accountId | string | No | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
--body | string | No | request body (JSON string, @file, or - for stdin) |
--propertyKey | string | Yes | The key of the user's property. The maximum length is 255 characters. |
--userKey | string | No | This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
--username | string | No | This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
Example:
jr user set-property --propertyKey <propertyKey>