The User datatype includes settings various settings.

Table: User

ParameterTypeRequired[a]DefaultDescription
idstringyes datatype user The identifier or token for the user.
displayNamestringyes The value of the fullName if used, otherwise the username.
usernamestringyes The user name for the account.
isRootbooleanyes Whether the user account is granted root access.
isOrgRootbooleanyes Whether the organization is granted root access.
fullNamestring  The user's full name (e.g., Bob Smith). Don't use if using other name parameters.
firstNamestring  The user's actual first name (e.g., Bob). Don't use with fullName.
lastNamestring  The user's actual last name or family name (e.g., Smith). Don't use with fullName.
phoneNumberstring  The telephone number for Humio to use for telephone text messages.
emailstring  The user account's email address for communications from Humio.
picturestring  File name of an image file for the account.
createdAtdatetimeyes The data and time the account was created.
countryCodestring  The two-letter ISO 3166-1 Alpha-2 code for the country of residence (e.g., us).
stateCodestring  The two-letter, ISO 3166-2 country sub-division code for the state of residence (e.g., ny).
locationstring  Deprecated since Februry 16, 2021. Use instead countryCode.
companystring  The name of the company for the user account.
userOrGroupSearchDomainRolestypeyes The number of results to skip or the offset to use. For instance, if implementing pagination, set skip = limit * (page - 1).
groupSearchDomainRolesGroupSearchDomainRoleyes The group search domain roles for the user (see GroupSearchDomainRole Table).
searchDomainRolesSearchDomainRole  The search domain roles assigned to the user (see SearchDomainRole Table).
searchDomainRolesByNamestringyes The search domain roles for the user, by name.
groupGroupyes The groups of which the user is a member.
permissionstypeyes Permissions of the user.
permissionsPagetypeyes PREVIEW: A page of user permissions.
allowedSystemActionsSystemActionyes Returns the actions the user is allowed to perform in the system.
allowedOrganizationActionsOrganizationActionyes Returns the actions the user is allowed to perform in the organization (see OrganizationAction Table).

[a] Some arguments may be required, as indicated in this column. For some fields this column indicates that a result will always being returned for it.