PingAuthorize Server Documentation Index
Configuration Reference Home

Third Party Token Resource Lookup Method

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.

Third Party Token Resource Lookup Method supports Token Resource Lookup Method implementations created in third-party code using the UnboundID Server SDK.

↓Parent Component
↓Properties
↓dsconfig Usage

Parent Component

The Third Party Token Resource Lookup Method component inherits from the Token Resource Lookup Method

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ evaluation-order-index
↓ extension-class
↓ extension-argument

Basic Properties

description

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

evaluation-order-index

Description
When multiple Token Resource Lookup Methods are defined for a single Access Token Validator, this property determines the order in which the lookup queries are executed. Values of this property must be unique among all Token Resource Lookup Methods defined for a single Access Token Validator but not necessarily contiguous. Token Resource Lookup Methods with a smaller value will be evaluated first to determine if they are able to locate the end-user resource.
Default Value
None
Allowed Values
An integer value. Lower limit is 0.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

extension-class (Read-Only)

Description
The fully-qualified name of the Java class providing the logic for the Third Party Token Resource Lookup Method.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sdk.broker.api.TokenResourceLookupMethod
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

extension-argument

Description
The set of arguments used to customize the behavior for the Third Party Token Resource Lookup Method. Each configuration property should be given in the form 'name=value'.
Default Value
None
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Token Resource Lookup Methods:

dsconfig list-token-resource-lookup-methods
     [--property {propertyName}] ...

To view the configuration for an existing Token Resource Lookup Method:

dsconfig get-token-resource-lookup-method-prop
     --method-name {name}
     --validator-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Token Resource Lookup Method:

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

To create a new Third Party Token Resource Lookup Method:

dsconfig create-token-resource-lookup-method
     --method-name {name}
     --validator-name {name}
     --type third-party
     --set evaluation-order-index:{propertyValue}
     --set extension-class:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Token Resource Lookup Method:

dsconfig delete-token-resource-lookup-method
     --method-name {name}
     --validator-name {name}