PingAuthorize API Reference

Policy Editor

The PingAuthorize Policy Editor APIs provide the tools to implement attribute-based access control and dynamic authorization management.

Authentication

Before making requests to the PingAuthorize Policy Editor endpoints, you must be authenticated. The following authentication methods are supported:

Method Description

None

Provide the x-user-id header with a userID value.

OIDC

Provide a valid token.

LDAP

Provide valid client credentials.

Paginated responses

Many of the PingAuthorize Policy Editor endpoints have the term "Paginated" appended to the response (e.g. Collection of Policy (Paginated)). Since these endpoints typically return several entities in a single response body, pagination limits the number of entities returned by specifying query parameters.

The following example represents a JSON paginated response:

{
    "pagination": {
        "page": 1,
        "pageSize": 10,
        "totalItems": 1,
        "totalPages": 1
    },
    "data": [
        {
            <data>
        }
    ]
}

In this example, the first page is returned with a limit of 10 entities. Since there is only a single entity and page, represented by the totalItems and totalPages properties, a second page is not queryable. In this case, the totalItems needs to reach 11 for a second page to be queryable.

Query parameters for paginated responses

Use the following query parameters for pagination:

Query parameter Description

page

Indicates which page of entities to return. For example, if the first page of entities returned does not contain a specific entity, then set page to 2 to return the next set of entities.

page-size

Indicate the maximum number of entities returned.