Class ConfluenceRestClientUsersConsumerApi

java.lang.Object
io.github.primelib.confluence4j.rest.v1.client.ConfluenceRestClientUsersConsumerApi
@Generated("io.github.primelib.primecodegen") public class ConfluenceRestClientUsersConsumerApi extends Object
ConfluenceRestClientUsersConsumerApi

  • Constructor Details

  • Method Details

    • GetUserV1

      public Map<String,Object> GetUserV1(Consumer<GetUserV1OperationSpec> spec)
      GetUserV1 Get 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. **Note:** to add, edit, or delete users in your organization, see the [user management REST API](/cloud/admin/user-management/about/). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).
      Parameters:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • accountId: The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
      • expand: A multi-value parameter indicating which properties of the user to expand. - `operations` returns the operations that the user is allowed to do. - `personalSpace` returns the user's personal space, if it exists. - `isExternalCollaborator`(@deprecated) see `isGuest` in response to find out whether the user is a guest.

    • GetUserAnonymousV1

      public UserAnonymous GetUserAnonymousV1(Consumer<GetUserAnonymousV1OperationSpec> spec)
      GetUserAnonymousV1 Get anonymous user Returns information about how anonymous users are represented, like the profile picture and display name. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).
      Parameters:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • expand: A multi-value parameter indicating which properties of the user to expand. - `operations` returns the operations that the user is allowed to do.

    • GetUserCurrentV1

      public Map<String,Object> GetUserCurrentV1(Consumer<GetUserCurrentV1OperationSpec> spec)
      GetUserCurrentV1 Get current user Returns the currently logged-in user. This includes information about the user, like the display name, userKey, account ID, profile picture, and more. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).
      Parameters:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • expand: A multi-value parameter indicating which properties of the user to expand. - `operations` returns the operations that the user is allowed to do. - `personalSpace` returns the user's personal space, if it exists. - `isExternalCollaborator`(@deprecated) see `isGuest` in response to find out whether the user is a guest.

    • GetUserMemberofV1

      public GroupArrayWithLinks GetUserMemberofV1(Consumer<GetUserMemberofV1OperationSpec> spec)
      GetUserMemberofV1 Get group memberships for user Returns the groups that a user is a member of. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).
      Parameters:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • accountId: The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
      • start: The starting index of the returned groups.
      • limit: The maximum number of groups to return per page. Note, this may be restricted by fixed system limits.

    • GetUserBulkV1

      public BulkUserLookupArray GetUserBulkV1(Consumer<GetUserBulkV1OperationSpec> spec)
      GetUserBulkV1 Get multiple users using ids 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](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).
      Parameters:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • accountId: A list of accountId's of users to be returned.
      • expand: A multi-value parameter indicating which properties of the user to expand. - `operations` returns the operations that the user is allowed to do. - `personalSpace` returns the user's personal space, if it exists. - `isExternalCollaborator`(@deprecated) use `isGuest` instead to return whether the user is a guest.

    • GetUserEmailV1

      public AccountIDEmailRecord GetUserEmailV1(Consumer<GetUserEmailV1OperationSpec> spec)
      GetUserEmailV1 Get user email address 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](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603). For Forge apps, this API only supports access via asApp() requests. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).
      Parameters:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • accountId: The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`. Required.

    • GetUserEmailBulkV1

      public List<AccountIDEmailRecord> GetUserEmailBulkV1(Consumer<GetUserEmailBulkV1OperationSpec> spec)
      GetUserEmailBulkV1 Get user email addresses in batch 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](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603). 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](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).
      Parameters:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • accountId: The account IDs of the users.