REST API First Steps

Document ID : KB000100886
Last Modified Date : 12/06/2018
Show Technical Document Details
Introduction:
This article is demonstrating very basic first steps how to enable and use the REST API in CA PAM.
Instructions:
1. Enable the REST API
User-added image

2. Logoff / Logon again to allow the new features in the UI to appear
User-added image

3. update the super user and add the API access key
    klick on the (+) and type any meaningful name for the key
User-added image

4. note down the API key details
    which is e.g. to be found in Credentials / Manage Targets / Accounts
    klick on the eye icon to view the credentials
User-added image

5.Open the REST API UI
   Settings / API Doc
User-added image

6. scroll down to e.g. the users section
User-added image

7. open the Create a User feature
User-added image

8.Replace the user details data with e.g.
{
    "email":"johndoe@example.com",
    "firstName":"John",
    "lastName":"Doe",
    "password":"changeMe",
    "userName":"johndoe"
}
User-added image

9. Submit the Request
    klicking the "Try Out" button
User-added image

10. enter the API Key credentials
User-added image

11. Confirm the transaction is successful
User-added image

12. Find the new user being created
User-added image
Additional Information:
Please see also the Product Documentation
https://docops.ca.com/ca-privileged-access-manager/3-2/EN/programming/external-api-for-integrating-applications