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
- Install postman from https://www.postman.com/downloads/
- Get access to CyberArk Identity tenant
- Have an admin user with user management rights
Import postman collection
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:
| Variable name | Description |
|---|---|
| tenant_url | The URL of the CyberArk Identity tenant (https://example.idaptive.app). The 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 | Description for the user that needs to be created |
| display_name | Display 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_login | 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 "Everybody" role |
| login_name | Login name for the user. This name will be used to represent the user on the admin portal |
| email_id | Email address of the user |
| mobile_number | Mobile number of the user |
| user_name | 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 |
| password confirm_password | Password for the user |
| password_never_expires | A boolean flag that specifies if the user's password expires or not |
| reports_to | The 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_name | The file name of the photo of the user |
| security_image | The file name for the security image for the user. Ex: security-image-6.jpg |
| user_state | The state of the user. It can be "Locked" / "Active" |
| use_alternate_mfa_account | A boolean flag specifies whether an alternate MFA account should be used or not. |
| redirect_user_uuid | The UUID of the user to which the MFA should be redirected to |
| cloud_state | Boolean flag that specifies if the user account is locked or not |
| additional_attribute_name | The name of the 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 | Boolean flag that specifies if the email invite should be sent or not. |
| send_sms_invite | Boolean flag that specifies if the SMS invite should be sent or not. |
| time_span | The time span for which the 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 |
Updated about 2 months ago