User Identification

In the beginning, the CLI has used the userId parameter to uniquely identify a user as was supported initially by the Atlassian applications. It use to represent a unique key. However, a few years ago, the applications supported renaming users and switched to some form of system generated unique user key to allow the user identifier to change. As applications changed, the CLI maintain it's terminology and mapped the underlying application changes to match. This has continued with the more recent Cloud changes and related GDPR efforts. 

Where possible with the Application provide support, the CLI will try to lookup the user by one or more ways to identify the user uniquely and this support differs by application and hosting type.

The user parameter should not be confused with the parameter indicated below. It represents the unique identifier that the application and hosting type require to login to their application. For server, this has and continues to be the user id used (or modified after) when the user was originally added to the instance (the userId parameter on the addUser CLI action for instance). For Cloud (at least in recent years), this must now be the email address that is associated with the Atlassian account and is the foundation of access to all Cloud instances the user is associated with. The email address is uniquely associated to the Atlassian account id. Atlassian allows for users to update the email associated with their Atlassian account. With the GDPR efforts, Atlassian is allowing users to choose what information is shared with others. The account id and user display name are always shared with others. Some Atlassian Cloud applications also expose a nickname or mention name that can be used as a short way to identify a user. If available, that will be reflected in the user id field in the CLI. Other fields like email address may also be exposed based on user preference. Any field that is not explicitly exposed by the user's choice and application will show as blank for those CLI actions that retrieve user information.

Note that Cloud applications may no longer support user management actions like addUser, updateUser, and removeUser. 

First line is the column name for the field. Second line is a related CLI parameter name. 

Jira CLI ServerJira CLI CloudConfluence CLI ServerConfluence CLI CloudBitbucket CLI Bitbucket Cloud CLI
User Key - system managed unique identifier that cannot be changed. On Cloud this is now known as the account id.

Key

userKey

Key

userKey

User KeyUser Key

Id (numeric)


User Key 

User Id - identifier, user name, nickname, or mention name. Usually an easier and memorable way to represent a user. This can be changed and is not necessarily unique in the Cloud instance.

User (unique)

userId

User

userId

User (unique)

userId

User

userId

User (unique)

userId

User

N/A

User Display Name - user controlled text to represent how user wants to be represented to others.

Name

userFullName

Name

N/A

Name

userFullName

Name

N/A

Name

userFullName

Name

N/A

User Email - Email address that may or may not be visible to other users.

Email

userEmail

Email

N/A

Email

userEmail

Email

N/A

Email

userEmail

N/A

N/A