Use the GET /authenticationPolicyContracts endpoint to get the Authentication Policy Contracts.

Path parameters

Parameter Value Description
page integer Page number to retrieve.
numberPerPage integer Number of contracts per page.
filter string Filter criteria limits the authentication policy contracts that are returned to only those that match it. The filter criteria is compared to the authentication policy contract name and ID fields. The comparison is a case-insensitive partial match. No additional pattern based matching is supported.

Status codes

Code Reason
200 Success.
403 PingFederate does not have the appropriate IdP/SP role enabled. Operation not available.
422 Validation error(s) occurred.

AuthenticationPolicyContracts - A collection of Authentication Policy Contracts

Property Type Description
items array[AuthenticationPolicyContract] The actual list of Authentication Policy Contracts.

AuthenticationPolicyContract - Authentication Policy Contracts carry user attributes from the identity provider to the service provider.

Property Type Description
coreAttributes array[AuthenticationPolicyContractAttribute] A list of read-only assertion attributes (for example, subject) that are automatically populated by PingFederate.
extendedAttributes array[AuthenticationPolicyContractAttribute] A list of additional attributes as needed.
id string The persistent, unique ID for the authentication policy contract. It can be any combination of [a-zA-Z0-9._-]. This property is system-assigned if not specified.
name string The Authentication Policy Contract Name. Name is unique.

AuthenticationPolicyContractAttribute - An attribute for the Authentication Policy Contract.

Property Type Description
name * string The name of this attribute.