UsersApi class - jira_platform library

Constructors

UsersApi(ApiClient _client)

Properties

hashCode → int: The hash code for this object.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

bulkGetUsers({int? startAt, int? maxResults, List<String>? username, List<String>? key, required List<String> accountId}) → Future<PageBeanUser>: Returns a paginated list of the users specified by one or more account IDs.
bulkGetUsersMigration({int? startAt, int? maxResults, List<String>? username, List<String>? key}) → Future<List<UserMigrationBean>>: Returns the account IDs for the users specified in the key or username parameters. Note that multiple key or username parameters can be specified.
createUser({required NewUserDetails body}) → Future<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.
getAllUsers({int? startAt, int? maxResults}) → Future<List<User>>: Returns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account.
getAllUsersDefault({int? startAt, int? maxResults}) → Future<List<User>>: Returns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account.
getUser({String? accountId, String? username, String? key, String? expand}) → Future<User>: Returns a user.
getUserDefaultColumns({String? accountId, String? username}) → Future<List<ColumnItem>>: Returns the default issue table columns for the user. If accountId is not passed in the request, the calling user's details are returned.
getUserEmail(String accountId) → Future<UnrestrictedUserEmail>: Returns a user's email address. This API is only available to apps approved by Atlassian, according to these guidelines.
getUserEmailBulk(List<String> accountId) → Future<UnrestrictedUserEmail>: Returns a user's email address. This API is only available to apps approved by Atlassian, according to these guidelines.
getUserGroups({required String accountId, String? username, String? key}) → Future<List<GroupName>>: Returns the groups to which a user belongs.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
removeUser({required String accountId, String? username, String? key}) → Future<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.
resetUserColumns({String? accountId, String? username}) → Future<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.
setUserColumns({String? accountId, required List<String> body}) → Future: 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.
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited