PingAuthorize Server Documentation Index
Configuration Reference Home

Token Resource Lookup Method

Note: this is an abstract component that cannot be instantiated.

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 Token Resource Lookup Method is used to look up the end-user account that is associated with an access token provided to authorize a resource request.

Direct Subcomponents
Relations to This Component
Properties
dsconfig Usage

Direct Subcomponents

The following Token Resource Lookup Methods are available in the server :

These Token Resource Lookup Methods inherit from the properties described below.

Relations to This Component

The following components have a direct composition relation to Token Resource Lookup Methods:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ evaluation-order-index

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


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 delete an existing Token Resource Lookup Method:

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