Completed

2

Where is API documentation ?

by: Mare S. | over a year ago | Integrations
This idea is
closed for voting.
return to idea list

Where is API documentation ?

by: Mare S. | over a year ago | Integrations

Comments

  • I'm going to count this ENH as a "Need to Improve API Documentation" vs. treating it as a question. However, from a question point of view. Please contact PAM Tech Support and they will be glad to help. As a side note - we are working on creating new integration documentation that will be addressing this concern.

    by: Michael Mychalczuk | over a year ago
    official response

  • At the time of posting this, API doc link was resulting in 404 error. Now it's available. I'm not developer by far, but this current docs are much to be desired.
    Our customer wants to store user personal certificates in PAM. Users are in AD, there is an inhouse application, where user authenticate via AD, and then would have to fetch this users certificate securely from PAM and present this to another 3rd party app for authentication.
    We would probably use Enterprise Credential Vault for storing this info, but if the developers will find all api calls they would need for our scenario, I'm not sure. I have to provide API documetation to developers by Friday, and then we will see their reaction ...

    by: Mare S. | over a year ago

  • Thank you for the feedback, and we agree that our API documentation is in need of help. This is a project that we will be taking up later this year. I have my ideas, as a PM, for what makes good API Documentation, but if you have examples of what you think is good documentation, then please share links here.

    For example: Here is an example of what I think good API documentation looks like https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_sobject_create.htm

    by: Michael Mychalczuk | over a year ago
    official response

  • With PAM 3.6, you can get the rest api doc(swagger) from the PAM installation from https://<your_pam_ip>/rest_api

    by: Rajesh K. | over a year ago