Skip to main content
Update an existing vault user (non-component users only). Master and Batch built-in users cannot be updated. Required Permissions for using this action:
  • Add/Update Users
  • Reset Password (required to edit changePassOnNextLogon)
External DocumentationTo learn more, visit the CyberArk documentation.

​
Basic Parameters

ParameterDescription
Enable UserSelect to set the user as enabled or disabled.
LocationThe vault location where the user account resides. Must be a valid vault path starting with backslash.
User IDThe ID of the non-component user to update.
User TypeThe type of user account based on your CyberArk license.
UsernameThe username of the user.
Vault AuthorizationVault-level permissions granted to the user.

Note: To apply specific authorizations to a user, the authenticated user must have the same authorizations.

​
Advanced Parameters

ParameterDescription
Authentication MethodThe authentication method this user will use to log in to the vault.
Business AddressThe user’s postal address object.

For example:
{
  “workStreet”: “Kuritania street”,
  “workCity”: “Curitania”,
  “workState”: “Suritania”,
  “workZip”: “90211”,
  “workCountry”: “Ruritania”
}
Change Password On Next LogonSelect whether or not the user must change their password after their first successful login.
DescriptionOptional notes or comments about the user.
Distinguished NameThe user’s distinguished name.
Expiry DateThe date and time when the user will expire.
InternetThe user’s email addresses and domains.

For example:
{
  “homePage”: “example.com”,
  “homeEmail”: “John@example.net”,
  “businessEmail”: “John@example.com”,
  “otherEmail”: “John@example.org”
}
PasswordAn initial password for the user account. Must comply with your organization’s password policy requirements.
Password Never ExpiresSelect whether the user’s first password will expire or remain valid indefinitely.
Personal DetailsThe user’s personal details.

For example:
{
  “street”:“Main street”,
  “city”:“Curitania”,
  “state”:“Suritania”,
  “zip”:“90210”,
  “country”:“Ruritania”,
  “title”:“Mr. John”,
  “organization”:“Acme”,
  “department”:“newco”,
  “profession”:“Doing Job”,
  “firstName”:“John”,
  “middleName”:“Doe”,
  “lastName”:“Roe”
}
PhonesThe user’s phone numbers.

For example:
{
  “homeNumber”: “555-0100”,
  “businessNumber”: “555-0101”,
  “cellularNumber”: “0491 570 156”,
  “faxNumber”: “555-0102”,
  “pagerNumber”: “555-0103”
}
Unauthorized InterfacesCyberArk interfaces and applications that this user is prohibited from accessing.
User Activity Log Retention DaysThe number of days to retain this user’s activity logs before automatic deletion.

Set to 0 to disable activity logging entirely.

​
Example Output

{
	"enableUser": true,
	"changePassOnNextLogon": false,
	"expiryDate": 1577836800,
	"suspended": false,
	"unAuthorizedInterfaces": [
		"GUI"
	],
	"authenticationMethod": [
		"AuthTypePass"
	],
	"allowedAuthenticationMethods": [
		"SAML",
		"PKI"
	],
	"passwordNeverExpires": true,
	"distinguishedName": "JohnDoeRoe",
	"description": "John Doe Roe",
	"businessAddress": {
		"workStreet": "Kuritania street",
		"workCity": "Curitania",
		"workState": "Suritania",
		"workZip": "90211",
		"workCountry": "Ruritania"
	},
	"internet": {
		"homePage": "example.com",
		"homeEmail": "John@example.net",
		"businessEmail": "John@example.com",
		"otherEmail": "John@example.org"
	},
	"phones": {
		"homeNumber": "555-0100",
		"businessNumber": "555-0101",
		"cellularNumber": "0491 570 156",
		"faxNumber": "555-0102",
		"pagerNumber": "555-0103"
	},
	"personalDetails": {
		"street": "Main street",
		"city": "Curitania",
		"state": "Suritania",
		"zip": "90210",
		"country": "Ruritania",
		"title": "Mr. John",
		"organization": "Acme",
		"department": "newco",
		"profession": "Doing Job",
		"firstName": "John",
		"middleName": "Doe",
		"lastName": "Roe"
	},
	"id": 24,
	"username": "JohnDR",
	"source": "CyberArk",
	"userType": "EPVUser",
	"componentUser": false,
	"vaultAuthorization": [
		"AuditUsers"
	],
	"location": "\\"
}

​
Workflow Library Example

Update User with Cyberark and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop
⌘I