Create, modify, delete and query the available Users in Jira.

Select

The 本製品 applies filters server-side only when supported for the specific column and operator, as documented in the Columns section. All other filters are processed client-side.

Cloud

The Jira Cloud API has no support for filtering by DisplayName and EmailAddress. These filters are processed client-side.

The only server-side supported filter is filtering by AccountId.

Example (processed server-side):

SELECT * FROM Users WHERE AccountId = '712020:fcd95543-59da-42bc-a0f2-4ab4265f07d4';

Server

The Jira Server API supports filtering by DisplayName and EmailAddress.

Examples (processed server-side):

SELECT * FROM Users WHERE DisplayName='JohnDoe';
SELECT * FROM Users WHERE EmailAddress = '[email protected]';

Filtering by Key is also server-side supported.

Example (processed server-side):

SELECT * FROM Users WHERE Key = 'JIRAUSER10472';

Note: In Jira Server version 10, due to an API limitation, it is not possible to retrieve more than the first 100 users returned by the Jira Server.

Insert

The input to INSERT must be an email address:

INSERT INTO Users(EmailAddress) VALUES ('[email protected]')

Update

To update a user, you should specify either the Key if connected to Server instance.

UPDATE Users SET DisplayName='TestInsertUpdated' WHERE Key= 'USR1'

Note: The Update operation is only supported for the Jira server instance.

Delete

To delete a user, you should specify either the Key if connected to Server instance, or the AccountId if connected to a Cloud instance.

DELETE FROM Users WHERE Key= 'USR1'
DELETE FROM Users WHERE AccountId= 'USR1'

Columns

Name	Type	ReadOnly	References	SupportedOperators	Platform	Description
AccountId [KEY]	String	True		=	Cloud	The accountId of the user, which uniquely identifies the user across all Atlassian products.
Key [KEY]	String	True			Server	The key of the user.
Name	String	False			Server	The name of the user.
DisplayName	String	False		=	Common	The display name of the user.
EmailAddress	String	False		=	Common	The email address of the user.
Active	Bool	True			Common	Indicates whether the user is active.
TimeZone	String	True			Common	The time zone specified in the user's profile.
Locale	String	True			Common	The locale of the user.
AccountType	String	False			Server	The accountType of the user.
Products	String	False			Server	A delimited string of jira products to which the user has access to, ex: jira-core,jira-servicedesk,jira-product-discovery,jira-software