PingAuthorize Server Documentation Index
Configuration Reference Home

String Token Claim Validation

Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.

Note: this component stores cluster-wide configuration data and is mirrored across all servers in the topology within the the same cluster.

Note: changes to cluster-wide configuration objects are immediately and automatically mirrored across all servers within the same cluster, so offline changes are not supported.

A String Token Claim Validation defines a validation condition for a single-valued string claim.

Parent Component
Properties
dsconfig Usage

Parent Component

The String Token Claim Validation component inherits from the Token Claim Validation

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ claim-name
↓ any-required-value

Basic Properties

description

Description
A description for this Token Claim Validation
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

claim-name

Description
The name of the claim to be validated. This claim must be present, and its name must be an exact match.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

any-required-value

Description
The set of values that the claim may have to be considered valid. The value of the claim being validated must be an exact match for one of the values specified by this property.
Default Value
None
Allowed Values
A string
Multi-Valued
Yes
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Token Claim Validations:

dsconfig list-token-claim-validations
     [--property {propertyName}] ...

To view the configuration for an existing Token Claim Validation:

dsconfig get-token-claim-validation-prop
     --validation-name {name}
     --validator-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Token Claim Validation:

dsconfig set-token-claim-validation-prop
     --validation-name {name}
     --validator-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new String Token Claim Validation:

dsconfig create-token-claim-validation
     --validation-name {name}
     --validator-name {name}
     --type string
     --set claim-name:{propertyValue}
     --set any-required-value:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Token Claim Validation:

dsconfig delete-token-claim-validation
     --validation-name {name}
     --validator-name {name}