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}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

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

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Create

  • Article
  • 3 minutes to read

Operation Information

This operation will create a new User in Active Directory.

Input Parameters

Name Type Description Required Sensitive
GivenName string The Given Name of the new User. Yes No
Surname string The Surname of the new User. Yes No
SamAccountName string The sAMAccountName of the new User. Must be unique within your Active Directory. Yes No
Path string The distinguished name of the OU/Container where you wish to create the User. No No
AccountPassword string The Password for the new User. Yes Yes
DisplayName string The Display Name for the new User. Yes No
Name string The Name of the new User. Must be unique within your Active Directory. Yes No
Server string The Active Directory Domain Services instance to perform the operation against. No No
AccountEnabled boolean Should the account be enabled. Defaults to false. Yes No
PasswordNeverExpires boolean Should the password be set to never expire. Defaults to false. Yes No
Initials string The Initials of the new User. No No
City string The User's City. No No
Company string The User's Company. No No
CountryCode string The User's Company Code. No No
Department string The User's Department. No No
Description string A Description of the new User. No No
EmailAddress string The User's Email Address. No No
EmployeeID string The User's Employee ID. No No
HomeDirectory string The User's Home Directory. No No
HomeDrive string The User's Home Drive. No No
Manager string The User's Managers Identity (distinguished, objectGUID, objectSid or sAMAccountName). No No
OfficeName string The User's Office Name. No No
Phone string The User's Phone Number. No No
PostalCode string The User's Postal Code. No No
ProfilePath string The User's Profile Path. No No
ProxyAddresses string The Proxy Addresses to set against the user. Separated by semi-colon characters. No No
ScriptPath string The User's logon script path. No No
State string The User's State or Region. No No
StreetAddress string The User's Street Address. No No
Title string The User's Title. No No
MiddleName string The User's Middle Name. No No
Groups string Comma-separated list of Groups to add the user to (objectGUID, objectSid or sAMAccountName) No No
AccountExpires string When the account should expire, as a date string in the format YYYY-MM-DD (the expire time will default to 00:00:00 when a date in this format is provided), or a full datetime string in the format YYYY-MM-DD HH:MM:SS No No
ChangePasswordAtLogon boolean Should the User be forced to change their password at initial logon. No No
AdditionalAttributes string Semi-colon seperated list of additional attributes to set, in the format key1=value1;key2=value2;keyX=valueX No No

Output Parameters

Name Type Description Required Sensitive
errors string Any errors returned by the operation No No
distinguishedName string The Distinguished Name of the new User. No No
objectGUID string The Object Globally Unique ID of the new User. No No
sid string The Secure ID of the new User. No No
outcome string Outcome of the operation. Can be OK, WARN or FAIL Yes No
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document