Users

Create user

Changed on

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 & no new jira-products are requested, the operation returns a 400 status.

Permissions required: Administer Jira global permission. The caller has to be an organization admin.

post/rest/api/2/user

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/user
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: manage:jira-configuration)
    • none

Request body

applicationKeysstring[]

Deprecated, do not use.

displayNamestring

This property is no longer available. If the user has an Atlassian account, their display name is not changed. If the user does not have an Atlassian account, they are sent an email asking them set up an account.

emailAddressstring required

The email address for the user.

keystring

This property is no longer available. See the migration guide for details.

namestring

This property is no longer available. See the migration guide for details.

passwordstring

This property is no longer available. If the user has an Atlassian account, their password is not changed. If the user does not have an Atlassian account, they are sent an email asking them set up an account.

productsstring[] required

Products the new user has access to. Valid products are: jira-core, jira-servicedesk, jira-product-discovery, jira-software. To create a user without product access, set this field to be an empty array.

selfstring

The URL of the user.

Response

Returned if the user already exists and already has the requested Jira product access.

accountIdstring

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.

accountType'atlassian' | 'app' | 'customer' | 'unknown'

The user account type. Can take the following values:

  • atlassian regular Atlassian user account
  • app system account used for Connect applications and OAuth to represent external systems
  • customer Jira Service Desk account representing an external service desk
activeboolean

Whether the user is active.

appTypestring

The app type of the user account when accountType is 'app'. Can take the following values:

  • service Service Account
  • agent Rovo Agent Account
  • unknown Unknown app type
displayNamestring

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

emailAddressstring

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

expandstring

Expand options that include additional user details in the response.

guestboolean

Whether the user is a guest.

keystring

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

localestring

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

namestring

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

selfstring uri

The URL of the user.

timeZonestring

The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned.

Changes