Privacy changes to Jira user object in REST API endpoints

Description

As documented in the notice to Jira Cloud API developers regarding upcoming changes to protect user privacy, we are introducing significant changes to Jira Cloud REST APIs to remove private user information.

This ticket tracks changes to the shape of user objects in all Jira Cloud REST APIs.

When a user object is returned in a Jira API today, it includes a number of attributes about a user, like emailAddress, displayName , and avatarUrls. These user objects will change substantially following the deprecation period. Below is a summary of changes:

Attribute

Status

self

Changed to reference Atlassian account API URL.

name

Removed following the deprecation period.

key

Will be changed to return the same value as accountId for new users without noticed and then removed following the deprecation period.

accountId

Will always be returned. Primary identifier for users.

emailAddress

Will be returned if allowed by user's privacy settings, may be null.

displayName

Value returned is determined by user's privacy settings, will be non-null.

active

No change

timeZone

Will be returned if allowed by user's privacy settings, may be null.

avatarUrls

Current avatar URL will be removed following the deprecation period. New avatar resources will be introduced.

nickname

(New) A user-customizable "handle" to refer to a user, such as in an @mention

Environment

None

Activity

Show:
Ben Kelley
November 7, 2018, 2:59 AM

These changes have now been rolled out.

Ben Kelley
November 7, 2018, 2:58 AM

Changes to allow our REST APIs to work with account IDs have been rolled out. Thanks to the people who have provided feedback about problems they have found.

I am going to close this particular ticket.

If you have particular things that don't work as described, I would request that you create a support request through your normal process so that our support team can more effectively assist you.

Of course there is https://community.atlassian.com/ where it is possible to discuss these things.

Ben Kelley
November 7, 2018, 2:54 AM
Edited

I don't have details on exactly how this will look, but I know that there will always be something returned for displayName.

Ben Kelley
November 7, 2018, 2:44 AM
Edited

I have raised a bug report for the removal of the avatarURLs from role actors at https://jira.atlassian.com/browse/JRACLOUD-70994

You will be able to track the status of this issue there.

Satvik Sharma
November 7, 2018, 12:03 AM

Thanks for the quick response. Would it be their nickname or would the user just be asked to put in a public name if they opt out of sharing their real name?

Fixed

Assignee

Unassigned

Reporter

Dave Meyer

Labels