Use a Postman collection for user management

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

Before you begin

Install Postman from https://www.postman.com/downloads/
Get access to CyberArk Identity tenant
Create an admin user with user management rights

Import the Postman collection

Get started with the 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 must have administrative rights to access the APIs.

Pre-fill the following variables for user management:

Variable name	Description
tenant_url	The URL of the CyberArk Identity tenant (https://example.idaptive.app) This URL will be used for all API requests to CyberArk Identity
admin_username	The username of the CyberArk Identity directory user that has administrative rights to manage users
admin_password	The password of the CyberArk Identity directory user.
user_description	A description of the user that needs to be created
display_name	The display name of the user that needs to be created
end_dateend_date_hourend_date_meridiemend_date_minute	The date and time after which the user becomes inactive in the system
change_password_on_next_login	A Boolean flag that represents whether the user has to change the password on the next login
home_number	The home number of the user
in_everybody_role	A Boolean flag that represents whether the user belongs to the Everybody role
login_name	The login name for the user This name will be used to represent the user on the admin portal.
email_id	The email address of the user
mobile_number	The mobile number of the user
user_name	The username of the user
oauth_client	A Boolean flag that specifies whether the user is an OAuth confidential client
office_number	The office number of the user
organization	The organization to which the user should belong
passwordconfirm_password	The password for the user
password_never_expires	A Boolean flag that specifies whether the user's password expires
reports_to	The name of the manager to whom the user reports
start_datestart_date_hourstart_date_meridiemstart_date_minute	The date and time after which the user becomes active in the system
user_photo_file_name	The file name of the photo of the user
security_image	The file name of the security image for the user For example: security-image-6.jpg
user_state	The state of the user Values: Locked, Active
use_alternate_mfa_account	A Boolean flag that specifies whether an alternate MFA account should be used
redirect_user_uuid	The UUID of the user to which MFA should be redirected
cloud_state	A Boolean flag that specifies whether the user account is locked
additional_attribute_name	The name of an additional attribute that needs to be added or modified
additional_attribute_value	The value of the additional attribute that needs to be added or modified
send_email_invite	A Boolean flag that specifies whether the email invite should be sent
send_sms_invite	A Boolean flag that specifies whether the SMS invite should be sent
time_span	The time span for which MFA should be unlocked for the user
alternate_user_name	An alternate name for the user This is required if you want to update the username for a user.
bulk_import_file_name	The file name for the bulk import CSV file