com.symphony.bdk.core.service.user

Class UserService

java.lang.Object

com.symphony.bdk.core.service.user.UserService

All Implemented Interfaces:

OboService<OboUserService>, OboUserService

@API(status=STABLE)
public class UserService
extends java.lang.Object
implements OboUserService, OboService<OboUserService>

Service class for managing users.

This service is used for retrieving information about a particular user, search users by ids, emails or usernames, perform some action related to user like:

• Add or remove roles from an user
• Get or update avatar of an user
• Get, assign or unassign disclaimer to an user
• Get, update feature entitlements of an user
• Get, update status of an user

Constructor Summary

Constructors

Constructor and Description
UserService(UserApi userApi, UsersApi usersApi, AuditTrailApi auditTrailApi, AuthSession authSession, RetryWithRecoveryBuilder<?> retryBuilder)
UserService(UserApi userApi, UsersApi usersApi, AuditTrailApi auditTrailApi, RetryWithRecoveryBuilder<?> retryBuilder)

Method Summary

Modifier and Type	Method and Description
void	addDisclaimer(java.lang.Long userId, java.lang.String disclaimerId) Assign disclaimer to an user.
void	addRole(java.lang.Long userId, RoleId roleId) Add a role to an user.
V2UserDetail	create(V2UserCreate payload) Creates a new user.
void	followUser(java.util.List<java.lang.Long> followerIds, java.lang.Long userId) Make a list of users to start following a specific user.
java.util.List<Avatar>	getAvatar(java.lang.Long userId) Get the url of avatar of an user
java.util.List<java.lang.Long>	getDelegates(java.lang.Long userId) Get delegates assigned to an user.
Disclaimer	getDisclaimer(java.lang.Long userId) Get disclaimer assigned to an user.
java.util.List<Feature>	getFeatureEntitlements(java.lang.Long userId) Get feature entitlements of an user.
UserStatus	getStatus(java.lang.Long userId) Get status of an user.
V2UserDetail	getUserDetail(java.lang.Long userId) Retrieve user details of a particular user.
java.util.stream.Stream<java.lang.Long>	listAllUserFollowers(java.lang.Long userId) Returns the Stream of followers of a specific user with default chunk size and total size equals 100.
java.util.stream.Stream<java.lang.Long>	listAllUserFollowers(java.lang.Long userId, StreamPaginationAttribute pagination) Returns the Stream of followers of a specific user.
java.util.stream.Stream<java.lang.Long>	listAllUserFollowing(java.lang.Long userId) Returns a Stream of users followed by a specific user with default chunk size and total size equals 100.
java.util.stream.Stream<java.lang.Long>	listAllUserFollowing(java.lang.Long userId, StreamPaginationAttribute pagination) Returns a Stream of users followed by a specific user.
java.util.stream.Stream<V2UserDetail>	listAllUsersDetail() Retrieve all users in the company (pod) and return in a Stream with default chunk size and total size equals 100.
java.util.stream.Stream<V2UserDetail>	listAllUsersDetail(StreamPaginationAttribute pagination) Retrieve all users in the company (pod) and return in a Stream.
java.util.stream.Stream<V2UserDetail>	listAllUsersDetail(UserFilter filter) Retrieve all of users in the company (pod) by a filter and return in a Stream with default chunk size and total size equals 100.
java.util.stream.Stream<V2UserDetail>	listAllUsersDetail(UserFilter filter, StreamPaginationAttribute pagination) Retrieve all of users in the company (pod) by a filter and return in a Stream.
V1AuditTrailInitiatorList	listAuditTrail(java.lang.Long startTimestamp, java.lang.Long endTimestamp, CursorPaginationAttribute pagination, java.lang.Long initiatorId, java.lang.String role) Returns audit trail of actions performed by a privileged user in a given period of time.
java.util.List<RoleDetail>	listRoles() List all roles in the pod
FollowersListResponse	listUserFollowers(java.lang.Long userId) Returns the list of followers of a specific user.
FollowersListResponse	listUserFollowers(java.lang.Long userId, CursorPaginationAttribute pagination) Returns the list of followers of a specific user.
java.util.List<UserV2>	listUsersByEmails(java.util.List<java.lang.String> emailList) listUsersByEmails(List)
java.util.List<UserV2>	listUsersByEmails(java.util.List<java.lang.String> emailList, java.lang.Boolean local, java.lang.Boolean active) listUsersByEmails(List, Boolean, Boolean)
java.util.List<UserV2>	listUsersByIds(java.util.List<java.lang.Long> uidList) listUsersByIds(List)
java.util.List<UserV2>	listUsersByIds(java.util.List<java.lang.Long> uidList, java.lang.Boolean local, java.lang.Boolean active) listUsersByIds(List, Boolean, Boolean)
java.util.List<UserV2>	listUsersByUsernames(java.util.List<java.lang.String> usernameList) listUsersByUsernames(List)
java.util.List<UserV2>	listUsersByUsernames(java.util.List<java.lang.String> usernameList, java.lang.Boolean active) listUsersByUsernames(List, Boolean)
java.util.List<V2UserDetail>	listUsersDetail() Retrieve all users in the company (pod).
java.util.List<V2UserDetail>	listUsersDetail(PaginationAttribute pagination) Retrieve all users in the company (pod).
java.util.List<V2UserDetail>	listUsersDetail(UserFilter filter) Retrieve a list of users in the company (pod) by a filter.
java.util.List<V2UserDetail>	listUsersDetail(UserFilter filter, PaginationAttribute pagination) Retrieve a list of users in the company (pod) by a filter.
FollowingListResponse	listUsersFollowing(java.lang.Long userId) Returns the list of users followed by a specific user.
FollowingListResponse	listUsersFollowing(java.lang.Long userId, CursorPaginationAttribute pagination) Returns the list of users followed by a specific user.
OboUserService	obo(AuthSession oboSession) Returns a new service instance with OBO-enabled endpoints from a given OBO session.
void	removeDisclaimer(java.lang.Long userId) Unassign disclaimer from an user.
void	removeRole(java.lang.Long userId, RoleId roleId) Remove a role from an user.
java.util.stream.Stream<UserV2>	searchAllUsers(UserSearchQuery query, java.lang.Boolean local) searchAllUsers(UserSearchQuery, Boolean)
java.util.stream.Stream<UserV2>	searchAllUsers(UserSearchQuery query, java.lang.Boolean local, StreamPaginationAttribute pagination) searchAllUsers(UserSearchQuery, Boolean, StreamPaginationAttribute)
java.util.List<UserV2>	searchUsers(UserSearchQuery query, java.lang.Boolean local) searchUsers(UserSearchQuery, Boolean)
java.util.List<UserV2>	searchUsers(UserSearchQuery query, java.lang.Boolean local, PaginationAttribute pagination) searchUsers(UserSearchQuery, Boolean, PaginationAttribute)
void	udpateDelegates(java.lang.Long userId, java.lang.Long delegatedUserId, DelegateAction.ActionEnum actionEnum) Update delegates assigned to an user.
void	unfollowUser(java.util.List<java.lang.Long> followerIds, java.lang.Long userId) Make a list of users to stop following a specific user.
V2UserDetail	update(java.lang.Long userId, V2UserAttributes payload) Updates an existing user
void	updateAvatar(java.lang.Long userId, byte[] image) Update avatar of an user
void	updateAvatar(java.lang.Long userId, java.io.InputStream imageStream) Update avatar of an user
void	updateAvatar(java.lang.Long userId, java.lang.String image) Update avatar of an user
void	updateFeatureEntitlements(java.lang.Long userId, java.util.List<Feature> features) Update feature entitlements of an user.
void	updateStatus(java.lang.Long userId, UserStatus status) Update the status of an user

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.symphony.bdk.core.service.OboService

checkAuthSession

Constructor Detail

UserService

public UserService(UserApi userApi,
                   UsersApi usersApi,
                   AuditTrailApi auditTrailApi,
                   AuthSession authSession,
                   RetryWithRecoveryBuilder<?> retryBuilder)

UserService

public UserService(UserApi userApi,
                   UsersApi usersApi,
                   AuditTrailApi auditTrailApi,
                   RetryWithRecoveryBuilder<?> retryBuilder)

Method Detail

obo

public OboUserService obo(AuthSession oboSession)

Description copied from interface: OboService

Returns a new service instance with OBO-enabled endpoints from a given OBO session.

Specified by:

obo in interface OboService<OboUserService>

Parameters:

oboSession - the OBO session

Returns:

the instance of the service class with OBO-enabled endpoints

listUsersByIds

public java.util.List<UserV2> listUsersByIds(@Nonnull
                                             java.util.List<java.lang.Long> uidList,
                                             @Nullable
                                             java.lang.Boolean local,
                                             @Nullable
                                             java.lang.Boolean active)

listUsersByIds(List, Boolean, Boolean)

Specified by:

listUsersByIds in interface OboUserService

Parameters:

uidList - List of user ids

local - If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned.

active - If not set all user status will be returned, if true all active users will be returned, if false all inactive users will be returned

Returns:

Users found by user ids

See Also:

Users Lookup V3

listUsersByIds

public java.util.List<UserV2> listUsersByIds(@Nonnull
                                             java.util.List<java.lang.Long> uidList)

listUsersByIds(List)

Specified by:

listUsersByIds in interface OboUserService

Parameters:

uidList - List of user ids

Returns:

Users found by user ids

See Also:

Users Lookup V3

listUsersByEmails

public java.util.List<UserV2> listUsersByEmails(@Nonnull
                                                java.util.List<java.lang.String> emailList,
                                                @Nullable
                                                java.lang.Boolean local,
                                                @Nullable
                                                java.lang.Boolean active)

listUsersByEmails(List, Boolean, Boolean)

Specified by:

listUsersByEmails in interface OboUserService

Parameters:

emailList - List of emails

local - If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned.

active - If not set all user status will be returned, if true all active users will be returned, if false all inactive users will be returned

Returns:

Users found by emails.

See Also:

Users Lookup V3

listUsersByEmails

public java.util.List<UserV2> listUsersByEmails(@Nonnull
                                                java.util.List<java.lang.String> emailList)

listUsersByEmails(List)

Specified by:

listUsersByEmails in interface OboUserService

Parameters:

emailList - List of emails

Returns:

Users found by emails

See Also:

Users Lookup V3

listUsersByUsernames

public java.util.List<UserV2> listUsersByUsernames(@Nonnull
                                                   java.util.List<java.lang.String> usernameList,
                                                   @Nullable
                                                   java.lang.Boolean active)

listUsersByUsernames(List, Boolean)

Specified by:

listUsersByUsernames in interface OboUserService

Parameters:

usernameList - List of usernames

active - If not set all user status will be returned, if true all active users will be returned, if false all inactive users will be returned

Returns:

Users found by usernames

See Also:

Users Lookup V3

listUsersByUsernames

public java.util.List<UserV2> listUsersByUsernames(@Nonnull
                                                   java.util.List<java.lang.String> usernameList)

listUsersByUsernames(List)

Specified by:

listUsersByUsernames in interface OboUserService

Parameters:

usernameList - List of usernames

Returns:

Users found by usernames

See Also:

Users Lookup V3

searchUsers

public java.util.List<UserV2> searchUsers(@Nonnull
                                          UserSearchQuery query,
                                          @Nullable
                                          java.lang.Boolean local)

searchUsers(UserSearchQuery, Boolean)

Specified by:

searchUsers in interface OboUserService

Parameters:

query - Searching query containing complicated information like title, location, company...

local - If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned.

Returns:

List of users found by query

See Also:

Search Users

searchUsers

public java.util.List<UserV2> searchUsers(@Nonnull
                                          UserSearchQuery query,
                                          @Nullable
                                          java.lang.Boolean local,
                                          @Nonnull
                                          PaginationAttribute pagination)

searchUsers(UserSearchQuery, Boolean, PaginationAttribute)

Specified by:

searchUsers in interface OboUserService

Parameters:

query - Searching query containing complicated information like title, location, company...

local - If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned.

pagination - The skip and limit for pagination.

Returns:

List of users found by query

See Also:

Search Users

searchAllUsers

@API(status=EXPERIMENTAL)
public java.util.stream.Stream<UserV2> searchAllUsers(@Nonnull
                                                                                UserSearchQuery query,
                                                                                @Nullable
                                                                                java.lang.Boolean local)

searchAllUsers(UserSearchQuery, Boolean)

Specified by:

searchAllUsers in interface OboUserService

Parameters:

query - Searching query containing complicated information like title, location, company...

local - If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned.

Returns:

a Stream of users found by query

See Also:

Search Users

searchAllUsers

@API(status=EXPERIMENTAL)
public java.util.stream.Stream<UserV2> searchAllUsers(@Nonnull
                                                                                UserSearchQuery query,
                                                                                @Nullable
                                                                                java.lang.Boolean local,
                                                                                @Nonnull
                                                                                StreamPaginationAttribute pagination)

searchAllUsers(UserSearchQuery, Boolean, StreamPaginationAttribute)

Specified by:

searchAllUsers in interface OboUserService

Parameters:

query - Searching query containing complicated information like title, location, company...

local - If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned.

pagination - The chunkSize and totalSize for pagination.

Returns:

a Stream of users found by query

See Also:

Search Users

followUser

public void followUser(@Nonnull
                       java.util.List<java.lang.Long> followerIds,
                       @Nonnull
                       java.lang.Long userId)

Make a list of users to start following a specific user. followUser(List, Long)

Specified by:

followUser in interface OboUserService

Parameters:

followerIds - List of ids of the followers.

userId - The id of the user to be followed.

See Also:

Follow User

unfollowUser

public void unfollowUser(@Nonnull
                         java.util.List<java.lang.Long> followerIds,
                         @Nonnull
                         java.lang.Long userId)

Make a list of users to stop following a specific user. unfollowUser(List, Long)

Specified by:

unfollowUser in interface OboUserService

Parameters:

followerIds - List of the ids of the followers.

userId - The id of the user to be unfollowed.

See Also:

Unfollow User

getUserDetail

public V2UserDetail getUserDetail(@Nonnull
                                  java.lang.Long userId)

Retrieve user details of a particular user.

Parameters:

userId - User Id

Returns:

Details of the user.

See Also:

Get User v2

listUsersDetail

public java.util.List<V2UserDetail> listUsersDetail()

Retrieve all users in the company (pod).

Returns:

List of retrieved users

See Also:

List Users V2

listUsersDetail

public java.util.List<V2UserDetail> listUsersDetail(@Nonnull
                                                    PaginationAttribute pagination)

Retrieve all users in the company (pod).

Parameters:

pagination - The skip and limit for pagination.

Returns:

List of retrieved users

See Also:

List Users V2

listAllUsersDetail

@API(status=EXPERIMENTAL)
public java.util.stream.Stream<V2UserDetail> listAllUsersDetail()

Retrieve all users in the company (pod) and return in a Stream with default chunk size and total size equals 100.

Returns:

a Stream of retrieved users

See Also:

List Users V2

listAllUsersDetail

@API(status=EXPERIMENTAL)
public java.util.stream.Stream<V2UserDetail> listAllUsersDetail(@Nonnull
                                                                                          StreamPaginationAttribute pagination)

Retrieve all users in the company (pod) and return in a Stream.

Parameters:

pagination - The chunkSize and totalSize for pagination.

Returns:

a Stream of retrieved users

See Also:

List Users V2

listUsersDetail

public java.util.List<V2UserDetail> listUsersDetail(@Nonnull
                                                    UserFilter filter)

Retrieve a list of users in the company (pod) by a filter.

Parameters:

filter - using to filter users by

Returns:

List of retrieved users

See Also:

Find Users V1, UserFeature

listUsersDetail

public java.util.List<V2UserDetail> listUsersDetail(@Nonnull
                                                    UserFilter filter,
                                                    @Nonnull
                                                    PaginationAttribute pagination)

Retrieve a list of users in the company (pod) by a filter.

Parameters:

filter - using to filter users by.

pagination - The skip and limit for pagination.

Returns:

List of retrieved users

See Also:

Find Users V1, UserFeature

listAllUsersDetail

@API(status=EXPERIMENTAL)
public java.util.stream.Stream<V2UserDetail> listAllUsersDetail(@Nonnull
                                                                                          UserFilter filter)

Retrieve all of users in the company (pod) by a filter and return in a Stream with default chunk size and total size equals 100.

Parameters:

filter - using to filter users by

Returns:

a Stream of retrieved users

See Also:

Find Users V1, UserFeature

listAllUsersDetail

@API(status=EXPERIMENTAL)
public java.util.stream.Stream<V2UserDetail> listAllUsersDetail(@Nonnull
                                                                                          UserFilter filter,
                                                                                          @Nonnull
                                                                                          StreamPaginationAttribute pagination)

Retrieve all of users in the company (pod) by a filter and return in a Stream.

Parameters:

filter - using to filter users by.

pagination - The chunkSize and totalSize for pagination.

Returns:

a Stream of retrieved users

See Also:

Find Users V1, UserFeature

addRole

public void addRole(@Nonnull
                    java.lang.Long userId,
                    @Nonnull
                    RoleId roleId)

Add a role to an user.

Parameters:

userId - User Id

roleId - Role Id

See Also:

Add Role

listRoles

public java.util.List<RoleDetail> listRoles()

List all roles in the pod

Returns:

List RoleDetail of all roles in the pod.

See Also:

List Roles

removeRole

public void removeRole(@Nonnull
                       java.lang.Long userId,
                       @Nonnull
                       RoleId roleId)

Remove a role from an user.

Parameters:

userId - User Id

roleId - Role Id

See Also:

Remove Role

getAvatar

public java.util.List<Avatar> getAvatar(@Nonnull
                                        java.lang.Long userId)

Get the url of avatar of an user

Parameters:

userId - User Id

Returns:

List of avatar urls of the user

See Also:

User Avatar

updateAvatar

public void updateAvatar(@Nonnull
                         java.lang.Long userId,
                         @Nonnull
                         java.lang.String image)

Update avatar of an user

Parameters:

userId - User Id

image - The avatar image for the user profile picture.The image must be a base64-encoded.

See Also:

Update User Avatar

updateAvatar

public void updateAvatar(@Nonnull
                         java.lang.Long userId,
                         @Nonnull
                         byte[] image)

Update avatar of an user

Parameters:

userId - User Id

image - The avatar image in bytes array for the user profile picture.

See Also:

Update User Avatar

updateAvatar

public void updateAvatar(@Nonnull
                         java.lang.Long userId,
                         @Nonnull
                         java.io.InputStream imageStream)
                  throws java.io.IOException

Update avatar of an user

Parameters:

userId - User Id

imageStream - The avatar image input stream for the user profile picture.

Throws:

java.io.IOException

See Also:

Update User Avatar

getDisclaimer

public Disclaimer getDisclaimer(@Nonnull
                                java.lang.Long userId)

Get disclaimer assigned to an user.

Parameters:

userId - User Id

Returns:

Disclaimer assigned to the user.

See Also:

User Disclaimer

removeDisclaimer

public void removeDisclaimer(@Nonnull
                             java.lang.Long userId)

Unassign disclaimer from an user.

Parameters:

userId - User Id

See Also:

Unassign User Disclaimer

addDisclaimer

public void addDisclaimer(@Nonnull
                          java.lang.Long userId,
                          @Nonnull
                          java.lang.String disclaimerId)

Assign disclaimer to an user.

Parameters:

userId - User Id

disclaimerId - Disclaimer to be assigned

See Also:

Update User Disclaimer

getDelegates

public java.util.List<java.lang.Long> getDelegates(@Nonnull
                                                   java.lang.Long userId)

Get delegates assigned to an user.

Parameters:

userId - User Id

Returns:

List of delegates assigned to an user.

See Also:

User Delegates

udpateDelegates

public void udpateDelegates(@Nonnull
                            java.lang.Long userId,
                            @Nonnull
                            java.lang.Long delegatedUserId,
                            @Nonnull
                            DelegateAction.ActionEnum actionEnum)

Update delegates assigned to an user.

Parameters:

userId - User Id

delegatedUserId - Delegated user Id to be assigned

actionEnum - Action to be performed

See Also:

Update User Delegates

getFeatureEntitlements

public java.util.List<Feature> getFeatureEntitlements(@Nonnull
                                                      java.lang.Long userId)

Get feature entitlements of an user.

Parameters:

userId - User Id

Returns:

List of feature entitlements of the user.

See Also:

User Features

updateFeatureEntitlements

public void updateFeatureEntitlements(@Nonnull
                                      java.lang.Long userId,
                                      @Nonnull
                                      java.util.List<Feature> features)

Update feature entitlements of an user.

Parameters:

userId - User Id

features - List of feature entitlements to be updated

See Also:

Update User Features

getStatus

public UserStatus getStatus(@Nonnull
                            java.lang.Long userId)

Get status of an user.

Parameters:

userId - User Id

Returns:

Status of the user.

See Also:

User Status

updateStatus

public void updateStatus(@Nonnull
                         java.lang.Long userId,
                         @Nonnull
                         UserStatus status)

Update the status of an user

Parameters:

userId - User Id

status - Status to be updated to the user

See Also:

Update User Status

listUserFollowers

public FollowersListResponse listUserFollowers(@Nonnull
                                               java.lang.Long userId)

Returns the list of followers of a specific user.

Parameters:

userId - User Id

Returns:

The list of followers of a specific user with the pagination information.

See Also:

List User Followers

listUserFollowers

public FollowersListResponse listUserFollowers(@Nonnull
                                               java.lang.Long userId,
                                               @Nonnull
                                               CursorPaginationAttribute pagination)

Returns the list of followers of a specific user.

Parameters:

userId - User Id

pagination - The range and limit for pagination.

Returns:

The list of followers of a specific user with the pagination information.

See Also:

List User Followers

listAllUserFollowers

@API(status=EXPERIMENTAL)
public java.util.stream.Stream<java.lang.Long> listAllUserFollowers(@Nonnull
                                                                                              java.lang.Long userId)

Returns the Stream of followers of a specific user with default chunk size and total size equals 100.

Parameters:

userId - User Id

Returns:

The Stream of followers of a specific user.

See Also:

List User Followers

listAllUserFollowers

@API(status=EXPERIMENTAL)
public java.util.stream.Stream<java.lang.Long> listAllUserFollowers(@Nonnull
                                                                                              java.lang.Long userId,
                                                                                              @Nonnull
                                                                                              StreamPaginationAttribute pagination)

Returns the Stream of followers of a specific user.

Parameters:

userId - User Id

pagination - The chunkSize and totalSize for pagination.

Returns:

The Stream of followers of a specific user.

See Also:

List User Followers

listUsersFollowing

public FollowingListResponse listUsersFollowing(@Nonnull
                                                java.lang.Long userId)

Returns the list of users followed by a specific user.

Parameters:

userId - User Id

Returns:

The list of users followed by a specific user with the pagination information.

See Also:

List User Followers

listUsersFollowing

public FollowingListResponse listUsersFollowing(@Nonnull
                                                java.lang.Long userId,
                                                @Nonnull
                                                CursorPaginationAttribute pagination)

Returns the list of users followed by a specific user.

Parameters:

userId - User Id

pagination - The range and limit for pagination.

Returns:

The list of users followed by a specific user with the pagination information.

See Also:

List Users Followed

listAllUserFollowing

@API(status=STABLE)
public java.util.stream.Stream<java.lang.Long> listAllUserFollowing(@Nonnull
                                                                                        java.lang.Long userId)

Returns a Stream of users followed by a specific user with default chunk size and total size equals 100.

Parameters:

userId - User Id

Returns:

a Stream of users followed by a specific user with the pagination information.

See Also:

List User Followers

listAllUserFollowing

@API(status=STABLE)
public java.util.stream.Stream<java.lang.Long> listAllUserFollowing(@Nonnull
                                                                                        java.lang.Long userId,
                                                                                        @Nonnull
                                                                                        StreamPaginationAttribute pagination)

Returns a Stream of users followed by a specific user.

Parameters:

userId - User Id

pagination - The chunkSize and totalSize for pagination.

Returns:

a Stream of users followed by a specific user with the pagination information.

See Also:

List User Followers

create

public V2UserDetail create(@Nonnull
                           V2UserCreate payload)

Creates a new user.

Parameters:

payload - User's details to create.

Returns:

a V2UserDetail with created user details.

See Also:

Create User v2

update

public V2UserDetail update(@Nonnull
                           java.lang.Long userId,
                           @Nonnull
                           V2UserAttributes payload)

Updates an existing user

Parameters:

userId - User Id

payload - User's new attributes for update.

Returns:

V2UserDetail with updated user details.

See Also:

Update User v2

listAuditTrail

public V1AuditTrailInitiatorList listAuditTrail(@Nonnull
                                                java.lang.Long startTimestamp,
                                                java.lang.Long endTimestamp,
                                                CursorPaginationAttribute pagination,
                                                java.lang.Long initiatorId,
                                                java.lang.String role)

Returns audit trail of actions performed by a privileged user in a given period of time.

Parameters:

startTimestamp - The start time of the period to retrieve the data.

endTimestamp - The end time of the period to retrieve the data.

pagination - The range and limit for pagination of data.

initiatorId - Privileged user id to list audit trail for.

role - Role to list audit trail for.

Returns:

V1AuditTrailInitiatorList with items and pagination.

See Also:

List Audit Trail v1