Add/Update UsersReset Password(required to editchangePassOnNextLogon)
External DocumentationTo learn more, visit the CyberArk documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Enable User | Select to set the user as enabled or disabled. |
| Location | The vault location where the user account resides. Must be a valid vault path starting with backslash. |
| User ID | The ID of the non-component user to update. |
| User Type | The type of user account based on your CyberArk license. |
| Username | The username of the user. |
| Vault Authorization | Vault-level permissions granted to the user. Note: To apply specific authorizations to a user, the authenticated user must have the same authorizations. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Authentication Method | The authentication method this user will use to log in to the vault. |
| Business Address | The user’s postal address object. For example: |
| Change Password On Next Logon | Select whether or not the user must change their password after their first successful login. |
| Description | Optional notes or comments about the user. |
| Distinguished Name | The user’s distinguished name. |
| Expiry Date | The date and time when the user will expire. |
| Internet | The user’s email addresses and domains. For example: |
| Password | An initial password for the user account. Must comply with your organization’s password policy requirements. |
| Password Never Expires | Select whether the user’s first password will expire or remain valid indefinitely. |
| Personal Details | The user’s personal details. For example: |
| Phones | The user’s phone numbers. For example: |
| Unauthorized Interfaces | CyberArk interfaces and applications that this user is prohibited from accessing. |
| User Activity Log Retention Days | The 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": "\\"
}