Individual attributes within policy contracts can further determine whether PingFederate approves or rejects requests. You can define those criteria to satisfy or you can choose to skip this configuration.
On the Issuance Criteria tab, define the criteria to satisfy in order for PingFederate to further process a request. Use this token authorization feature to conditionally approve or reject requests based on individual attributes.
Begin this optional configuration by choosing the source that contains the attribute to verify. Some sources are common to almost all use cases, such as Mapped Attributes. Other sources depend on the type of configuration, such as JDBC. Irrelevant sources are automatically hidden. After you select a source, choose the attribute to verify. Depending on the selected source, the available attributes or properties vary. Specify the comparison condition and the desired value to compare to.
You can define multiple criteria, which must all be satisfied in order for PingFederate to move a request to the next phase. A criterion is satisfied when the runtime value of the selected attribute matches or does not match the specified value, depending on the chosen comparison method. The multi-value contains ... or multi-value does not contain ... comparison methods are intended for attributes that can contain multiple values. Such a criterion is considered satisfied if one of the multiple values match or does not match the specified value. Values are compared verbatim. If you require complex evaluations, including conditional criteria or partial matching, define them using attribute mapping expressions.
All criteria defined must be satisfied, or evaluated as true, for a request to move forward, regardless of how the criteria were defined. As soon as one criterion fails, PingFederate rejects the request and returns an error message.
- Go to Add Mapping. and select your mapping, or click
On the Issuance Criteria tab, select the attribute's source from the Source list.
Depending on the selection, the Attribute Name list populates with associated attributes. See the following table for more information.
Source Description Context Select to evaluate properties returned from the context of the transaction at runtime.Note:
As the HTTP Request context value is retrieved as a Java object rather than text, attribute mapping expressions are more appropriate to evaluate and return values.
Extended Client Metadata Select to evaluate OAuth client metadata. JDBC, LDAP, or other types of datastore (if configured) Select to evaluate attributes returned from a data source. Mapped Attributes Select to evaluate the mapped attributes. Mapped from Context (Adapter, Authentication Policy Contract, IdP Connection, Password Credential Validator, token exchange Processor Policy) Select to evaluate attributes from the authentication source.
Visible and applicable only when configuring an access token mapping where the source of the attribute is something other than Client Credentials and Default. See Managing access token mappings.
Persistent Grant Select to evaluate the default attribute USER_KEY and other extended attributes (if defined) from the persistent grant.
Visible and applicable only when configuring an access token mapping where the source of the attribute is not Client Credentials.
- From the Attribute Name list, select the attribute to be evaluated.
From the Condition
list, select the comparison method.
- equal to
- equal to (case insensitive)
- equal to DN
- not equal to
- not equal to (case insensitive)
- not equal to DN
- multi-value contains
- multi-value contains (case insensitive)
- multi-value contains DN
- multi-value does not contain
- multi-value does not contain (case insensitive)
- multi-value does not contain DN
The first six conditions are intended for single-value attributes. Use one of the multi-value ... conditions for PingFederate to validate whether one of the attribute values matches the specified value. When an attribute has multiple values, using a single-value condition causes the criteria to fail.
In the Value field, enter the comparison value.
Values are compared verbatim. If you require complex evaluations, including conditional criteria or partial matching, define them using attribute mapping expressions. For more information, see Attribute mapping expressions.
In the Error Result
field, enter a custom error message.
The value of this field is used by the error_description protocol field. Using an error code in the Error Result field allows an application to process the code in a variety of ways; for example, display an error message or e-mail an administrator.To use localized descriptions, enter a unique alias in the Error Result field, such as someIssuanceCriterionFailed. Insert the same alias with the desired localized text in the applicable language resource files, located in the <pf_install>/pingfederate/server/default/conf/language-packs directory.
If not defined, PingFederate returns ACCESS_DENIED when the criterion fails at runtime.
- Click Add.
- Optional: Repeat to add more criteria.
require complex evaluations, including conditional criteria or partial matching,
define them using attribute mapping expressions. For more information, see Attribute mapping expressions.
- Click Show Advanced Criteria.
- In the Expression field, enter the required expressions.
In the Error Result field, enter an error code or
If the expressions resolve to a string value instead of
false, the returned value overrides the Error Result field value.
- Click Add.
- Optional: Click Test, enter values in the applicable fields, and verify the results.
- Optional: Repeat to add multiple criteria using attribute mapping expressions.