ATatlassian
Users

Get user

Returns a user. This includes information about the user, such as the display name, account ID, profile picture, and more. The information returned may be restricted by the user's profile visibility settings.

Note: to add, edit, or delete users in your organization, see the user management REST API.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

get/wiki/rest/api/user

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/wiki/rest/api/user
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:confluence-user

Query parameters

accountIdstring required

The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.

expandstring[]

A multi-value parameter indicating which properties of the user to expand.

  • operations returns the operations that the user is allowed to do.
  • personalSpace returns the user's personal space, if it exists.
  • isExternalCollaborator(@deprecated) see isGuest in response to find out whether the user is a guest.

Response

Returned if the requested user is returned.

type'known' | 'unknown' | 'anonymous' | 'user' required
usernamestring nullable

This property is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.

userKeystring nullable

This property is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.

accountIdstring nullable

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.

accountType'atlassian' | 'app' | ''

The account type of the user, may return empty string if unavailable. App is if the user is a bot user created on behalf of an Atlassian app.

emailstring nullable

The email address of the user. Depending on the user's privacy setting, this may return an empty string.

publicNamestring

The public name or nickname of the user. Will always contain a value.

displayNamestring nullable

The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName.

timeZonestring nullable

This displays user time zone. Depending on the user's privacy setting, this may return null.

externalCollaboratorboolean

This is deprecated. Use isGuest instead to find out whether the user is a guest user.

isExternalCollaboratorboolean

This is deprecated. Use isGuest instead to find out whether the user is a guest user.

isGuestboolean

Whether the user is a guest user

_linksGenericLinks

Changes

No recorded changes to this operation across all 2 revisions of this API.