Skip to main content

users

Overview

Nameusers
TypeResource
Idsumologic.users.users

Fields

NameDatatypeDescription
idstringUnique identifier for the user.
isActivebooleanTrue if the user is active.
createdBystringIdentifier of the user who created the resource.
modifiedBystringIdentifier of the user who last modified the resource.
isMfaEnabledbooleanTrue if multi factor authentication is enabled for the user.
roleIdsarrayList of roleIds associated with the user.
createdAtstringCreation timestamp in UTC in RFC3339 format.
modifiedAtstringLast modification timestamp in UTC.
lastLoginTimestampstringTimestamp of the last login for the user in UTC. Will be null if the user has never logged in.
lastNamestringLast name of the user.
firstNamestringFirst name of the user.
isLockedbooleanThis has the value true if the user's account has been locked. If a user tries to log into their account several times and fails, his or her account will be locked for security reasons.
emailstringEmail address of the user.

Methods

NameAccessible byRequired ParamsDescription
getUserSELECTid, regionGet a user with the given identifier from the organization.
listUsersSELECTregionGet a list of all users in the organization. The response is paginated with a default limit of 100 users per page.
createUserINSERTdata__email, data__firstName, data__lastName, data__roleIds, regionCreate a new user in the organization.
deleteUserDELETEid, regionDelete a user with the given identifier from the organization and transfer their content to the user with the identifier specified in "transferTo".
updateUserEXECid, data__firstName, data__isActive, data__lastName, data__roleIds, regionUpdate an existing user in the organization.