Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

/ admin / userCreate

  • Article
  • 3 minutes to read

Description

Invoke this method to create a user.

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is none
  • Transactional database functions are used during this method when supported by the target database.
System Rights Database Rights Mail Rights Calendar Rights
sys.a.manageUsers
sys.a.createUser
 --- --- ---

Request Parameters

The userCreate method takes the following input parameters.

Note

When sending a JSON request payload to the API, the order of parameters is not significant. However, for XML request payloads, parameters must be provided in the exact order specified in this documentation to comply with input validation requirements.

Name Type Attributes Description
userId accountIdType Required The ID of the user to create.
loginId loginIdType Optional The Login ID for this user, will use userId if not specified
employeeId accountIdType Optional The Employee ID for this user
name nameType Required The display name of the user.
password passwordType Required The password to set for the user. This password must be BASE64 encoded to ensure that no plain text passwords are transmitted over the wire. If you provide an empty string here, the password will not be set, in this case, direct login will not be allowed for this account
userType accountUserType Optional
Default=user		 The type of user to create, either ‘user’ or ‘basic’.
enable2fa twofaMethodType Optional
Default=disabled		 Set this to use two-factor authentication method for this account.
nonUserAccount xs:boolean Optional If set to ‘true’ the account will not be visible in user browse/search lists.
firstName nameType Optional The first name of the user.
lastName xs:string Optional The last name of the user.
jobTitle xs:string Optional The job title of the user.
homeOrganization groupIdType Optional The home organization of the user.
site xs:string Optional The site where this co-worker is based.
phone xs:string Optional The direct dial telephone number for the user.
email rfc822AddressType Optional The email for the user.
mobile xs:string Optional The cell phone number for the user (used for SMS notification).
availabilityStatus numberType Optional
Default=1		 The availability status currently set for this user. If not specified, then the default will be 1.
absenceMessage xs:string Optional The absence message set for this user.
timeZone xs:string Optional The default Time Zone applied to this user. If you want to get a list of timezones, please see the time::getTimezoneList. The default value will be picked up from this setting i.e security.user.autoProvisioning.default.timeZone
language xs:language Optional The assigned language of the user. The default value will be picked up from this setting i.e security.user.autoProvisioning.default.language
dateTimeFormat xs:string Optional The default date/time format of the user. The default value will be picked up from this setting i.e security.user.autoProvisioning.default.dateTimeFormat
dateFormat xs:string Optional The default date format of the user. The default value will be picked up from this setting i.e security.user.autoProvisioning.default.dateFormat
timeFormat xs:string Optional The default time format of the user. The default value will be picked up from this setting i.e security.user.autoProvisioning.default.timeFormat
currencySymbol xs:string Optional The default currency symbol of the user. The default value will be picked up from this setting i.e security.user.autoProvisioning.default.currencySymbol
countryCode countryCodeType Optional The default country code of the user. The default value will be picked up from this setting i.e security.user.autoProvisioning.default.countryCode
securityOptions userAccountSecurityOptionsType Optional Security related account options.
notifyEmail xs:boolean Optional Enables/Disables notifications to this users e-mail address.
notifyTextMessage xs:boolean Optional Enables/Disables notifications to this users mobile phone via SMS text messaging.
personalMailRights mailboxRightsType Optional The rights to grant on this users personal mailbox. If not specified - all rights are granted. This is ignored when creating a basic user
userProfile userExtendedProfileData Optional When creating a full user, this property can be used to set the extended user profile properties.
properties Array<userPropType> Optional Optional list of extensible name/type/value account properties to attach to the new user. Each entry is inserted into h_sys_accounts_props. See userSetProps for the upsert semantics applied here.

Response Parameters

This method returns no response parameters.

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document