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.
The Groovy Scripted OAuth Token Handler provides a token handler implementation defined in a dynamically-loaded script which implements the com.unboundid.directory.sdk.http.scripting.ScriptedOAuthTokenHandler class in the UnboundID Server SDK.
The Groovy Scripted OAuth Token Handler component inherits from the Scripted OAuth Token Handler
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| description | None |
| script-argument | |
| script-class |
| 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 |
| Description | The set of arguments used to customize the behavior for the Scripted OAuth Token Handler. Each configuration property should be given in the form 'name=value'. |
| Default Value | None |
| Allowed Values | An argument in the form 'name=value'. Argument names are allowed to contain only ASCII alphabetic characters, numeric digits, dashes, and underscores. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The fully-qualified name of the Groovy class providing the logic for the Groovy Scripted OAuth Token Handler. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
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 Groovy Scripted OAuth Token Handler:
dsconfig create-oauth-token-handler
--handler-name {name}
--type groovy
--set script-class:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing OAuth Token Handler:
dsconfig delete-oauth-token-handler
--handler-name {name}