Directory Server Documentation Index
Configuration Reference Home

Third Party Oauth Token Handler

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 UnboundID support in order to understand the potential impact of that change.

The Third Party Oauth Token Handler provides a token handler implementation created in third-party code which implements the com.unboundid.directory.sdk.http.api.OAuthTokenHandler class in the UnboundID Server SDK.

↓Parent Component
↓Properties
↓dsconfig Usage

Parent Component

The Third Party Oauth Token Handler component inherits from the Oauth Token Handler

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ extension-class
↓ extension-argument

Basic Properties

description

Description
A description for this Oauth Token Handler
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
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 Oauth Token Handler.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sdk.http.api.OAuthTokenHandler
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 Oauth Token Handler. 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 Oauth Token Handlers:

dsconfig list-oauth-token-handlers
     [--property {propertyName}] ...

To view the configuration for an existing Oauth Token Handler:

dsconfig get-oauth-token-handler-prop
     --handler-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Oauth Token Handler:

dsconfig set-oauth-token-handler-prop
     --handler-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Third Party Oauth Token Handler:

dsconfig create-oauth-token-handler
     --handler-name {name}
     --type third-party
     --set extension-class:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Oauth Token Handler:

dsconfig delete-oauth-token-handler
     --handler-name {name}