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 usernameAdministrator
and passwordPassword1
. -
The
-k
parameter specifies to ignore HTTPS certificate issues. -
The
-H "X-Xsrf-Header: PingAccess"
parameter sends anX-XSRF-Header
with valuePingAccess
.
Accessing the interactive administrative API documentation
View interactive documentation for the administrative API endpoints.
Steps
-
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.
-
Enter the administrator username and password.
-
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:
-
Click to expand the
/applications
endpoint. -
Click to expand the
GET
method (GET /applications
). -
Enter values for the parameters or leave them all blank.
-
Click Try It Out.
Result:
The request Uniform Resource Locator (URL), response body, response code, and response headers display.
-