Class Users

Index

Constructors

Methods

getAnonymousUser getBulkUserLookup getBulkUserMigration getCurrentUser getGroupMembershipsForUser getPrivacyUnsafeUserEmail getPrivacyUnsafeUserEmailBulk getUser

Constructors

constructor

new Users(client: Client): Users
Parameters
- client: Client
Returns Users
- Defined in src/api/users.ts:8

Methods

getAnonymousUser

getAnonymousUser<T = UserAnonymous>(
parameters: undefined | GetAnonymousUser,
callback: Callback<T>,
): Promise<void>
Returns information about how anonymous users are represented, like the profile picture and display name.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = UserAnonymous
Parameters
- parameters: undefined | GetAnonymousUser
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/users.ts:53
getAnonymousUser<T = UserAnonymous>(
parameters?: GetAnonymousUser,
callback?: undefined,
): Promise<T>
Returns information about how anonymous users are represented, like the profile picture and display name.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = UserAnonymous
Parameters
- Optionalparameters: GetAnonymousUser
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/users.ts:63

getBulkUserLookup

getBulkUserLookup<T = BulkUserLookupArray>(
parameters: GetBulkUserLookup,
callback: Callback<T>,
): Promise<void>
Returns user details for the ids provided in the request. Currently this API returns a maximum of 100 results. If more than 100 account ids are passed in, then the first 100 will be returned.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = BulkUserLookupArray
Parameters
- parameters: GetBulkUserLookup
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/users.ts:162
getBulkUserLookup<T = BulkUserLookupArray>(
parameters: GetBulkUserLookup,
callback?: undefined,
): Promise<T>
Returns user details for the ids provided in the request. Currently this API returns a maximum of 100 results. If more than 100 account ids are passed in, then the first 100 will be returned.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = BulkUserLookupArray
Parameters
- parameters: GetBulkUserLookup
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/users.ts:173

getBulkUserMigration

getBulkUserMigration<T = MigratedUserArray>(
parameters: GetBulkUserMigration,
callback: Callback<T>,
): Promise<void>
Returns the accountIds for the users specified in the key or username parameters. Note that multiple key and username parameters can be specified.

Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = MigratedUserArray
Parameters
- parameters: GetBulkUserMigration
- callback: Callback<T>
Returns Promise<void>
Deprecated
Will be removed in next major version.
- Defined in src/api/users.ts:289
getBulkUserMigration<T = MigratedUserArray>(
parameters: GetBulkUserMigration,
callback?: undefined,
): Promise<T>
Returns the accountIds for the users specified in the key or username parameters. Note that multiple key and username parameters can be specified.

Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = MigratedUserArray
Parameters
- parameters: GetBulkUserMigration
- Optionalcallback: undefined
Returns Promise<T>
Deprecated
Will be removed in next major version.
- Defined in src/api/users.ts:302

getCurrentUser

getCurrentUser<T = User>(
parameters: undefined | GetCurrentUser,
callback: Callback<T>,
): Promise<void>
Returns the currently logged-in user. This includes information about the user, like the display name, userKey, account ID, profile picture, and more.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = User
Parameters
- parameters: undefined | GetCurrentUser
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/users.ts:89
getCurrentUser<T = User>(
parameters?: GetCurrentUser,
callback?: undefined,
): Promise<T>
Returns the currently logged-in user. This includes information about the user, like the display name, userKey, account ID, profile picture, and more.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = User
Parameters
- Optionalparameters: GetCurrentUser
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/users.ts:100

getGroupMembershipsForUser

getGroupMembershipsForUser<T = GroupArrayWithLinks>(
parameters: GetGroupMembershipsForUser,
callback: Callback<T>,
): Promise<void>
Returns the groups that a user is a member of.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = GroupArrayWithLinks
Parameters
- parameters: GetGroupMembershipsForUser
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/users.ts:122
getGroupMembershipsForUser<T = GroupArrayWithLinks>(
parameters: GetGroupMembershipsForUser,
callback?: undefined,
): Promise<T>
Returns the groups that a user is a member of.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = GroupArrayWithLinks
Parameters
- parameters: GetGroupMembershipsForUser
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/users.ts:132

getPrivacyUnsafeUserEmail

getPrivacyUnsafeUserEmail<T = AccountIdEmailRecord>(
parameters: GetPrivacyUnsafeUserEmail,
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.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = AccountIdEmailRecord
Parameters
- parameters: GetPrivacyUnsafeUserEmail
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/users.ts:203
getPrivacyUnsafeUserEmail<T = AccountIdEmailRecord>(
parameters: GetPrivacyUnsafeUserEmail,
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.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = AccountIdEmailRecord
Parameters
- parameters: GetPrivacyUnsafeUserEmail
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/users.ts:216

getPrivacyUnsafeUserEmailBulk

getPrivacyUnsafeUserEmailBulk<T = AccountIdEmailRecordArray>(
parameters: GetPrivacyUnsafeUserEmailBulk,
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.

Any accounts which are not available will not be included in the result.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = AccountIdEmailRecordArray
Parameters
- parameters: GetPrivacyUnsafeUserEmailBulk
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/users.ts:246
getPrivacyUnsafeUserEmailBulk<T = AccountIdEmailRecordArray>(
parameters: GetPrivacyUnsafeUserEmailBulk,
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.

Any accounts which are not available will not be included in the result.

Permissions required: Permission to access the Confluence site ('Can use' global permission).
Type Parameters
- T = AccountIdEmailRecordArray
Parameters
- parameters: GetPrivacyUnsafeUserEmailBulk
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/users.ts:261

getUser

getUser<T = User>(parameters: GetUser, callback: Callback<T>): Promise<void>
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).
Type Parameters
- T = User
Parameters
- parameters: GetUser
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/users.ts:20
getUser<T = User>(parameters: GetUser, callback?: undefined): Promise<T>
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).
Type Parameters
- T = User
Parameters
- parameters: GetUser
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/users.ts:31

Class Users

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Users

Methods

getAnonymousUser

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getBulkUserLookup

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getBulkUserMigration

Type Parameters

Parameters

Returns Promise<void>

Deprecated

Type Parameters

Parameters

Returns Promise<T>

Deprecated

getCurrentUser

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getGroupMembershipsForUser

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getPrivacyUnsafeUserEmail

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getPrivacyUnsafeUserEmailBulk

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>

Settings

On This Page