Postman collection for user management

This guide helps you to test the CyberArk Identity user management APIs using postman collection. Postman is an HTTP testing API application that allows you to monitor requests and responses.

Prerequisites

Import postman collection

Run in PostmanRun in Postman

Get started with postman collection

Once the postman collection is imported, the following variables have to be pre-filled to run the collection based on the functionality you want to try out.

❗️

Authentication is required to access the APIs related to user management. The authenticated user should contain administrative rights to access the APIs.

The following variables should be pre-filled for user management:

18341834
Variable nameDescription
tenant_urlThe URL of the CyberArk Identity tenant (https://example.idaptive.app). The URL will be used for all API requests to CyberArk Identity.
admin_usernameThe username of the CyberArk Identity directory user that has administrative rights to manage users.
admin_passwordThe password of the CyberArk Identity directory user.
user_descriptionDescription for the user that needs to be created
display_nameDisplay name of the user that needs to be created
end_date
end_date_hour
end_date_meridiem
end_date_minute
The date time after which the user becomes inactive in the system
change_password_on_next_loginBoolean flag that represents whether the user has to change the password on the next login
home_numberThe home number of the user
in_everybody_roleA boolean flag that represents whether the user belongs to "Everybody" role
login_nameLogin name for the user. This name will be used to represent the user on the admin portal
email_idEmail address of the user
mobile_numberMobile number of the user
user_nameUsername of the user
oauth_clientA boolean flag that specifies whether the user is an OAuth confidential client
office_numberThe office number of the user
organizationThe organization to which the user should belong
password
confirm_password
Password for the user
password_never_expiresA boolean flag that specifies if the user's password expires or not
reports_toThe name of the manager to which the user reports to
start_date
start_date_hour
start_date_meridiem
start_date_minute
The date and time after which the user becomes active in the system
user_photo_file_nameThe file name of the photo of the user
security_imageThe file name for the security image for the user. Ex: security-image-6.jpg
user_stateThe state of the user. It can be "Locked" / "Active"
use_alternate_mfa_accountA boolean flag specifies whether an alternate MFA account should be used or not.
redirect_user_uuidThe UUID of the user to which the MFA should be redirected to
cloud_stateBoolean flag that specifies if the user account is locked or not
additional_attribute_nameThe name of the additional attribute that needs to be added or modified
additional_attribute_valueThe value of the additional attribute that needs to be added or modified
send_email_inviteBoolean flag that specifies if the email invite should be sent or not.
send_sms_inviteBoolean flag that specifies if the SMS invite should be sent or not.
time_spanThe time span for which the MFA should be unlocked for the user
alternate_user_nameAn alternate name for the user. This is required if you want to update the username for a user.
bulk_import_file_nameThe file name for the bulk import CSV file