REST API First Steps

Products

• CA Privileged Access Manager (PAM)

Issue/Introduction

This article is demonstrating very basic first steps how to start using the API Doc or Rest API in CA Privileged Access Manager (PAM).

Environment

CA Privileged Access Manager 4.x

Resolution

 

1. Enable the REST API. Go to Configuration > Security > Access > Access tab > External REST API, set it to Enabled

2. Logoff / Logon again to allow Rest API features in the UI to appear

3. Go to Users > Manage Users and update the super user and add the API access key, click on the (+) and type any meaningful name for the key and click [OK]

4. Go to Credentials > Manage Targets > Accounts, select generated API key account, click on the eye icon to view the credentials. Note down the API key account name and credential. 

5. Go to Settings > API Doc to open the Rest API UI

6. Scroll down to e.g. the users section

7. Open/Click the "Create a user" API call

8. Replace the user details data with e.g.

{
    "email": "[email protected]",
    "firstName": "John",
    "lastName": "Doe",
    "password": "<password>",
    "userName": "johndoe"
}

Note: replace <password> with password that contains alphabet and numeric values

9. Click the [Try it out!] button to submit the request

10. Enter the credentials from the API Key target account we have noted down at step 4.

11. Confirm the transaction is successful

12. Go to Users > Manage Users and you should find the new user being created

 

 

Additional Information

Please see also the Product Documentation

PAM External REST API