Class Users

Index

Constructors

Methods

bulkGetUsers bulkGetUsersMigration createUser getAllUsers getAllUsersDefault getUser getUserDefaultColumns getUserEmail getUserEmailBulk getUserGroups removeUser resetUserColumns setUserColumns

Constructors

constructor

new Users(client: Client): Version3.Users
Parameters
- client: Client
Returns Version3.Users
- Defined in src/version3/users.ts:9

Methods

bulkGetUsers

bulkGetUsers<T = Version3Models.PageUser>(
parameters: Version3Parameters.BulkGetUsers,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of the users specified by one or more account IDs.

Permissions required: Permission to access Jira.
Type Parameters
- T = Version3Models.PageUser
Parameters
- parameters: Version3Parameters.BulkGetUsers
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/users.ts:123
bulkGetUsers<T = Version3Models.PageUser>(
parameters: Version3Parameters.BulkGetUsers,
callback?: undefined,
): Promise<T>
Returns a paginated list of the users specified by one or more account IDs.

Permissions required: Permission to access Jira.
Type Parameters
- T = Version3Models.PageUser
Parameters
- parameters: Version3Parameters.BulkGetUsers
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/users.ts:131

bulkGetUsersMigration

bulkGetUsersMigration<T = Version3Models.UserMigration[]>(
parameters: Version3Parameters.BulkGetUsersMigration,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version3Models.UserMigration[]
Parameters
- parameters: Version3Parameters.BulkGetUsersMigration
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/users.ts:156
bulkGetUsersMigration<T = Version3Models.UserMigration[]>(
parameters: Version3Parameters.BulkGetUsersMigration,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version3Models.UserMigration[]
Parameters
- parameters: Version3Parameters.BulkGetUsersMigration
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/users.ts:167

createUser

createUser<T = Version3Models.User>(
parameters: Version3Parameters.CreateUser,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version3Models.User
Parameters
- parameters: Version3Parameters.CreateUser
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/users.ts:58
createUser<T = Version3Models.User>(
parameters: Version3Parameters.CreateUser,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version3Models.User
Parameters
- parameters: Version3Parameters.CreateUser
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/users.ts:69

getAllUsers

getAllUsers<T = Version3Models.User[]>(
parameters: undefined | Version3Parameters.GetAllUsers,
callback: Callback<T>,
): Promise<void>
Returns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account.

Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

Permissions required: Browse users and groups global permission.
Type Parameters
- T = Version3Models.User[]
Parameters
- parameters: undefined | Version3Parameters.GetAllUsers
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/users.ts:460
getAllUsers<T = Version3Models.User[]>(
parameters?: Version3Parameters.GetAllUsers,
callback?: undefined,
): Promise<T>
Returns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account.

Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

Permissions required: Browse users and groups global permission.
Type Parameters
- T = Version3Models.User[]
Parameters
- Optionalparameters: Version3Parameters.GetAllUsers
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/users.ts:475

getAllUsersDefault

getAllUsersDefault<T = Version3Models.User[]>(
parameters: undefined | Version3Parameters.GetAllUsersDefault,
callback: Callback<T>,
): Promise<void>
Returns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account.

Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

Permissions required: Browse users and groups global permission.
Type Parameters
- T = Version3Models.User[]
Parameters
- parameters: undefined | Version3Parameters.GetAllUsersDefault
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/users.ts:417
getAllUsersDefault<T = Version3Models.User[]>(
parameters?: Version3Parameters.GetAllUsersDefault,
callback?: undefined,
): Promise<T>
Returns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account.

Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

Permissions required: Browse users and groups global permission.
Type Parameters
- T = Version3Models.User[]
Parameters
- Optionalparameters: Version3Parameters.GetAllUsersDefault
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/users.ts:432

getUser

getUser<T = Version3Models.User>(
parameters: Version3Parameters.GetUser,
callback: Callback<T>,
): Promise<void>
Returns a user.

Privacy controls are applied to the response based on the user's preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

Permissions required: Browse users and groups global permission.
Type Parameters
- T = Version3Models.User
Parameters
- parameters: Version3Parameters.GetUser
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/users.ts:21
getUser<T = Version3Models.User>(
parameters: Version3Parameters.GetUser,
callback?: undefined,
): Promise<T>
Returns a user.

Privacy controls are applied to the response based on the user's preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

Permissions required: Browse users and groups global permission.
Type Parameters
- T = Version3Models.User
Parameters
- parameters: Version3Parameters.GetUser
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/users.ts:32

getUserDefaultColumns

getUserDefaultColumns<T = Version3Models.ColumnItem[]>(
parameters: undefined | Version3Parameters.GetUserDefaultColumns,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version3Models.ColumnItem[]
Parameters
- parameters: undefined | Version3Parameters.GetUserDefaultColumns
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/users.ts:199
getUserDefaultColumns<T = Version3Models.ColumnItem[]>(
parameters?: Version3Parameters.GetUserDefaultColumns,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version3Models.ColumnItem[]
Parameters
- Optionalparameters: Version3Parameters.GetUserDefaultColumns
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/users.ts:213

getUserEmail

getUserEmail<T = Version3Models.UnrestrictedUserEmail>(
parameters: string | Version3Parameters.GetUserEmail,
callback: Callback<T>,
): Promise<void>
Returns a user's email address regardless of the user's profile visibility settings. For Connect apps, this API is only available to apps approved by Atlassian, according to these guidelines. For Forge apps, this API only supports access via asApp() requests.
Type Parameters
- T = Version3Models.UnrestrictedUserEmail
Parameters
- parameters: string | Version3Parameters.GetUserEmail
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/users.ts:306
getUserEmail<T = Version3Models.UnrestrictedUserEmail>(
parameters: string | Version3Parameters.GetUserEmail,
callback?: undefined,
): Promise<T>
Returns a user's email address regardless of the user's profile visibility settings. For Connect apps, this API is only available to apps approved by Atlassian, according to these guidelines. For Forge apps, this API only supports access via asApp() requests.
Type Parameters
- T = Version3Models.UnrestrictedUserEmail
Parameters
- parameters: string | Version3Parameters.GetUserEmail
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/users.ts:316

getUserEmailBulk

getUserEmailBulk<T = Version3Models.UnrestrictedUserEmail>(
parameters: string | Version3Parameters.GetUserEmailBulk,
callback: Callback<T>,
): Promise<void>
Returns a user's email address regardless of the user's profile visibility settings. For Connect apps, this API is only available to apps approved by Atlassian, according to these guidelines. For Forge apps, this API only supports access via asApp() requests.
Type Parameters
- T = Version3Models.UnrestrictedUserEmail
Parameters
- parameters: string | Version3Parameters.GetUserEmailBulk
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/users.ts:343
getUserEmailBulk<T = Version3Models.UnrestrictedUserEmail>(
parameters: string | Version3Parameters.GetUserEmailBulk,
callback?: undefined,
): Promise<T>
Returns a user's email address regardless of the user's profile visibility settings. For Connect apps, this API is only available to apps approved by Atlassian, according to these guidelines. For Forge apps, this API only supports access via asApp() requests.
Type Parameters
- T = Version3Models.UnrestrictedUserEmail
Parameters
- parameters: string | Version3Parameters.GetUserEmailBulk
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/users.ts:353

getUserGroups

getUserGroups<T = Version3Models.GroupName[]>(
parameters: Version3Parameters.GetUserGroups,
callback: Callback<T>,
): Promise<void>
Returns the groups to which a user belongs.

Permissions required: Browse users and groups global permission.
Type Parameters
- T = Version3Models.GroupName[]
Parameters
- parameters: Version3Parameters.GetUserGroups
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/users.ts:380
getUserGroups<T = Version3Models.GroupName[]>(
parameters: Version3Parameters.GetUserGroups,
callback?: undefined,
): Promise<T>
Returns the groups to which a user belongs.

Permissions required: Browse users and groups global permission.
Type Parameters
- T = Version3Models.GroupName[]
Parameters
- parameters: Version3Parameters.GetUserGroups
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/users.ts:390

removeUser

removeUser<T = void>(
parameters: Version3Parameters.RemoveUser,
callback: Callback<T>,
): Promise<void>
Deletes a user. If the operation completes successfully then the user is removed from Jira's user base. This operation does not delete the user's Atlassian account.

Permissions required: Site administration (that is, membership of the site-admin group).
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.RemoveUser
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/users.ts:93
removeUser<T = void>(
parameters: Version3Parameters.RemoveUser,
callback?: undefined,
): Promise<T>
Deletes a user. If the operation completes successfully then the user is removed from Jira's user base. This operation does not delete the user's Atlassian account.

Permissions required: Site administration (that is, membership of the site-admin group).
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.RemoveUser
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/users.ts:101

resetUserColumns

resetUserColumns<T = void>(
parameters: Version3Parameters.ResetUserColumns,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.ResetUserColumns
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/users.ts:276
resetUserColumns<T = void>(
parameters: Version3Parameters.ResetUserColumns,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.ResetUserColumns
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/users.ts:286

setUserColumns

setUserColumns<T = string>(
parameters: Version3Parameters.SetUserColumns,
callback: Callback<T>,
): Promise<void>
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.

Permissions required:
- Administer Jira global permission, to set the columns on any user.
- Permission to access Jira, to set the calling user's columns.
Type Parameters
- T = string
Parameters
- parameters: Version3Parameters.SetUserColumns
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/users.ts:242
setUserColumns<T = string>(
parameters: Version3Parameters.SetUserColumns,
callback?: undefined,
): Promise<T>
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.

Permissions required:
- Administer Jira global permission, to set the columns on any user.
- Permission to access Jira, to set the calling user's columns.
Type Parameters
- T = string
Parameters
- parameters: Version3Parameters.SetUserColumns
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/users.ts:253

Class Users

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.Users

Methods

bulkGetUsers

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

bulkGetUsersMigration

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

createUser

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getAllUsers

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getAllUsersDefault

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getUser

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getUserDefaultColumns

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getUserEmail

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getUserEmailBulk

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getUserGroups

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

removeUser