Skip to main content

Create User

POST 
/createUser

This API onboard or create a new user.

The Authorization must have Bearer followed by Token.

Optional Parameters:

validateagainstpolicy - Values: Y/N, default is Y. Checks for the password policy,

statuskey - Values:1/0, 0 - Inactive, 1 - Active (default),

allowpastdate - true / false (default). If true, allows startdate to be less than current date,

User params like
username,
firstname,
preferedFirstName,
lastname,
middlename,
street,
city,
comments,
statuskey,
startdate(MM-dd-yyyy),
enddate(MM-dd-yyyy),
manager (manager username),
password,
location,
jobCode,
jobDescription,
employeeType,
departmentNumber,
title,
state,
companyname,
costcenter,
departmentname,
employeeclass,
entity,
jobcodedesc,
locationdesc,
locationnumber,
siteid,
orgunitid,
region,
regioncode,
owner,
employeeid,
lastsyncdate,
createdate,
email,
phonenumber,
job_function,
country,
displayname,
enabled(can be "1"/"true" or "0"/"false"),
passwordExpired(can be "1"/"true" or "0"/"false"),
accountExpired(can be "1"/"true" or "0"/"false"),
accountLocked(can be "1"/"true" or "0"/"false"),
secondaryManager,
createdBy,
termDate,
vendorManager,
secondaryPhone,
secondaryEmail,
customproperty<1-50>,
hcp<1-5>,
ecp<1-5>,
customer(pass the organization name),

securityQuestions -

Example:
"securityQuestions":[
{
"securityQuestion":"What is your first Pet's name?",
"securityAnswer":"kitty"
},
{
"securityQuestion":"What is your favorite food?",
"securityAnswer":"food"
}
],

checkrules - true/ false (default : true), if true, then rules will be evaluated immediately, if false rules will be evaluated by a job. If checkrulesforapi configuration(true/false/null) is set in the configuration table, then it will take precendence over checkrules parameter.

inlineruleevaluation - true/ false (default is true), if true then rules will be evaluated immediately, if false rules will be evaluated by a job.

Note - CreateUser API will not invoke workflow based on the User Modification Workflow configuration. Please use createUserRequest API instead.

Note - Both checkrules and inlineruleevaluation need to be set as true for the user update rules to be evaluated immediately.

batchidentifier - When inlineruleevaluation=false, this Rule Run Unique Identifier can be set and user update rules can be processed later by calling /api/processrules API

It's highly recommended to pass inlineruleevaluation:"false" for bulk load and call processrules api to evaluate and run the rules after the load is done.

Request​

Body

    accountExpired string
    accountLocked string
    allowpastdate string
    enabled string
    enddate string
    firstname string
    passwordExpired string
    startdate string
    statuskey string
    username string

Responses​

Create User

Response Headers

  • Date

    string

  • Server

    string

  • Set-Cookie

    string

  • Transfer-Encoding

    string

  • X-Frame-Options

    string

Schema

    errorCode string
    message string
Loading...