Home

Atlassian User (version v1.*.*)

Jira Cloud platform User REST API. Designed to be used for endpoints that do not support OAuth access.

create_user#

Creates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is available this resource will be deprecated.

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, the operation returns a 400 status.

Permissions required: Administer Jira global permission.

Parameters

$body#

Details about the user to be created.

Type: object

{
  "emailAddress" : "The email address for the user.",
  "displayName" : "A suggested display name for the user. If the user has an Atlassian account, their display name is not changed. If the user does not have an Atlassian account, this display name is used as a suggestion for creating an account. The user is sent an email asking them to set their display name and privacy preferences.",
  "self" : "The URL of the user."
}

get_user#

Returns a user.

Permissions required: Browse users and groups global permission.

Parameters

accountId#

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

Type: string

expand#

Use expand to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include:

  • groups includes all groups and nested groups to which the user belongs.
  • applicationRoles includes details of all the applications to which the user has access.

Type: string

remove_user#

Deletes a user.

Permissions required: Site administration (that is, membership of the site-admin group).

Parameters

accountId (required)#

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

Type: string