Connectors
...
Actions
Add User
5 min
description adds a new user to the cyberark vault with the provided username via a json body input endpoint url /passwordvault/api/users/ method post inputs json body (object) – required username (string) – required the name of the user usertype (string) the user type that was returned according to the license unauthorizedinterfaces (array) the user type that was returned according to the license location (string) the location in the vault where the user will be created expirydate (number) the date when the user expires useractivitylogretentiondays (number) the number of days that a user's account activity records are stored before they are deleted loginfromhour (number) the starting time of the timeframe in which a user can log in to an account logintohour (number) the ending time of the timeframe in which a user can log in to an account enableuser (boolean) whether the user will be enabled upon creation authenticationmethod (array) the authentication method that the user will use to log on initialpassword (string) the password that the user will use to log on for the first time changepassonnextlogon (boolean) whether or not the user must change their password from the second log on onward passwordneverexpires (boolean) whether the user's password will not expire unless they decide to change it distinguishedname (string) the user's distinguished name vaultauthorization (array) the user permissions businessaddress (object) the user's postal address, including city, state, zip, country and street workstreet (string) workcity (string) workstate (string) workzip (string) workcountry (string) internet (object) the user's email addresses, including home page, home email, business email and other email homepage (string) homeemail (string) businessemail (string) otheremail (string) phones (object) the user's phone numbers, including home, business, cellular, fax and pager homenumber (string) businessnumber (string) cellularnumber (string) faxnumber (string) pagernumber (string) description (string) notes and comments personaldetails (object) street (string) city (string) state (string) zip (string) country (string) title (string) organization (string) department (string) profession (string) firstname (string) middlename (string) lastname (string) output example \[ { "status code" 201, "response headers" {}, "reason" "created", "json body" { "enableuser" true, "changepassonnextlogon" true, "expirydate" 1577836800, "suspended" false, "lastsuccessfullogindate" 1561282853, "unauthorizedinterfaces" \[ "psmp", "psm" ], "authenticationmethod" \[ "authtypepass" ], "passwordneverexpires" true, "distinguishedname" "newuser\@cyberark", "description" "this user is privileged", "businessaddress" { "workstreet" "9999999", "workcity" "white mountain", "workstate" "10 first street", "workzip" "123456", "workcountry" "canada" }, "internet" { "homepage" "cyberark com", "homeemail" "user\@gmail com", "businessemail" "user\@cyberark com", "otheremail" "user2\@gmail com" }, "phones" { "homenumber" "555123456", "businessnumber" "555456789", "cellularnumber" "555789789", "faxnumber" "999999", "pagernumber" "111111" }, "personaldetails" { "street" "3 second street", "city" "tel aviv", "state" "israel", "zip" "123456", "country" "israel", "title" "manager", "organization" "cyberark", "department" "r\&d", "profession" "software development", "firstname" "john", "middlename" "david", "lastname" "smith" }, "id" 350, "username" "newuser", "source" "cyberark", "usertype" "epvuser", "componentuser" false, "vaultauthorization" \[ "addsafes", "auditusers" ], "location" "\\\\" } } ] output parameters status code (number) reason (string) json body (object) enableuser (boolean) changepassonnextlogon (boolean) expirydate (number) suspended (boolean) lastsuccessfullogindate (number) unauthorizedinterfaces (array) authenticationmethod (array) passwordneverexpires (boolean) distinguishedname (string) description (string) businessaddress (object) workstreet (string) workcity (string) workstate (string) workzip (string) workcountry (string) internet (object) homepage (string) homeemail (string) businessemail (string) otheremail (string) phones (object) homenumber (string) businessnumber (string) cellularnumber (string) faxnumber (string) pagernumber (string) personaldetails (object) street (string) city (string) state (string) zip (string) country (string) title (string) organization (string) department (string) profession (string) firstname (string) middlename (string) lastname (string) id (number) username (string) source (string) usertype (string) componentuser (boolean) vaultauthorization (array) location (string)