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

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

The OAuth Token Handler is used to support OAuth 2.0 bearer tokens in the SCIM HTTP Servlet Extension. Implementations are created in third-party code using the UnboundID Server SDK.

Since RFC 6750 does not specify the format for the contents of a bearer token, the OAuthTokenHandler API allows us to handle different implementations of the token from different types of Authorization Servers.

Direct Subcomponents Relations to This Component Properties dsconfig Usage

Direct Subcomponents

The following OAuth Token Handlers are available in the server :

These OAuth Token Handlers inherit from the properties described below.

Relations to This Component

The following components have a direct aggregation relation to OAuth Token Handlers:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
 description  None

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


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 delete an existing OAuth Token Handler:

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