Module users_api

Enums

BulkGetUsersError

struct for typed errors of method bulk_get_users

BulkGetUsersMigrationError

struct for typed errors of method bulk_get_users_migration

CreateUserError

struct for typed errors of method create_user

GetAllUsersDefaultError

struct for typed errors of method get_all_users_default

GetAllUsersError

struct for typed errors of method get_all_users

GetUserDefaultColumnsError

struct for typed errors of method get_user_default_columns

GetUserEmailBulkError

struct for typed errors of method get_user_email_bulk

GetUserEmailError

struct for typed errors of method get_user_email

GetUserError

struct for typed errors of method get_user

GetUserGroupsError

struct for typed errors of method get_user_groups

RemoveUserError

struct for typed errors of method remove_user

ResetUserColumnsError

struct for typed errors of method reset_user_columns

SetUserColumnsError

struct for typed errors of method set_user_columns

Functions

bulk_get_users

Returns a paginated list of the users specified by one or more account IDs. Permissions required: Permission to access Jira.

bulk_get_users_migration

Returns the account IDs for the users specified in the key or username parameters. Note that multiple key or username parameters can be specified. Permissions required: Permission to access Jira.

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.

get_all_users

Returns a list of all (active and inactive) users. Permissions required: Browse users and groups global permission.

get_all_users_default

Returns a list of all (active and inactive) users. Permissions required: Browse users and groups global permission.

get_user

Returns a user. Permissions required: Browse users and groups global permission.

get_user_default_columns

Returns the default issue table columns for the user. If accountId is not passed in the request, the calling user’s details are returned. Permissions required: * Administer Jira global permission, to get the column details for any user. * Permission to access Jira, to get the calling user’s column details.

get_user_email

Returns a user’s email address. This API is only available to apps approved by Atlassian, according to these guidelines.

get_user_email_bulk

Returns a user’s email address. This API is only available to apps approved by Atlassian, according to these guidelines.

get_user_groups

Returns the groups to which a user belongs. Permissions required: Browse users and groups global permission.

remove_user

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

reset_user_columns

Resets the default issue table columns for the user to the system default. If accountId is not passed, the calling user’s default columns are reset. Permissions required: * Administer Jira global permission, to set the columns on any user. * Permission to access Jira, to set the calling user’s columns.

set_user_columns

Sets the default issue table columns for the user. If an account ID is not passed, the calling user’s default columns are set. If no column details are sent, then all default columns are removed. The parameters for this resource are expressed as HTML form data. For example, in curl: curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/user/columns?accountId=5b10ac8d82e05b22cc7d4ef5' Permissions required: * Administer Jira global permission, to set the columns on any user. * Permission to access Jira, to set the calling user’s columns.