UsersApi class

This document describes the REST API and resources provided by Confluence. The REST APIs are for developers who want to integrate Confluence into their application and for administrators who want to script interactions with the Confluence server.Confluence's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The response format is JSON. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE. Because the REST API is based on open standards, you can use any web development language to access the API.

Constructors

UsersApi(ApiClient _client)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

getAnonymousUser({List<String>? expand}) → Future<UserAnonymous>

Returns information about how anonymous users are represented, like the profile picture and display name.

getBulkUserLookup({required String accountId, List<String>? expand, int? limit}) → Future<BulkUserLookupArray>

Returns user details for the ids provided in request.

getCurrentUser({List<String>? expand}) → Future<User>

Returns the currently logged-in user. This includes information about the user, like the display name, userKey, account ID, profile picture, and more.

getGroupMembershipsForUser({required String accountId, int? start, int? limit}) → Future<GroupArrayWithLinks>

Returns the groups that a user is a member of.

getPrivacyUnsafeUserEmail(String accountId) → Future<AccountIdEmailRecord>

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

getPrivacyUnsafeUserEmailBulk(List<String> accountId) → Future<AccountIdEmailRecordArray>

Returns user email addresses for a set of accountIds. This API is only available to apps approved by Atlassian, according to these guidelines.

getUser({required String accountId, List<String>? expand}) → Future<User>

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.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited