PingAccess

Accessing the PingAccess administrative API

Access the PingAccess administrative application programming interface (API).

Steps

  • Send an HTTP request to this URL: https://<host>:<admin-port>/pa-admin-api/v3/api-endpoint.

    You must provide appropriate administrator credentials in the request.

Example

For example, the following cURL command will return a list of all defined applications by sending a GET request to the applications resource:

curl -k -u Administrator:Password1 -H "X-Xsrf-Header: PingAccess" https://localhost:9000/pa-admin-api/v3/applications

  • The -u Administrator:Password1 parameter sends basic authentication header with the username Administrator and password Password1.

  • The -k parameter specifies to ignore HTTPS certificate issues.

  • The -H "X-Xsrf-Header: PingAccess" parameter sends an X-XSRF-Header with value PingAccess.

Accessing the interactive administrative API documentation

View interactive documentation for the administrative API endpoints.

Steps

  1. Launch your browser and go to https://<host>:<admin-port>/pa-admin-api/v3/api-docs/.

    Example:

    https://localhost:9000/pa-admin-api/v3/api-docs/

    The browser might prompt you to enter your credentials.

  2. Enter the administrator username and password.

  3. Use the administrative API to perform a variety of administrative tasks, such as gathering information.

    Example:

    To use the interactive administrative API documentation to see all defined applications:

    1. Click to expand the /applications endpoint.

    2. Click to expand the GET method (GET /applications).

    3. Enter values for the parameters or leave them all blank.

    4. Click Try It Out.

    Result:

    The request Uniform Resource Locator (URL), response body, response code, and response headers display.