PingAuthorize Server Documentation Index
Configuration Reference Home

Third Party SCIM Sub Resource Type 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 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 Third Party SCIM Sub Resource Type Handler provides a third-party implementation of a custom SCIM Sub-Resource Type Handler.

Parent Component
Properties
dsconfig Usage

Parent Component

The Third Party SCIM Sub Resource Type Handler component inherits from the SCIM Sub Resource Type Handler

Properties

The properties supported by this managed object are as follows:


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

Basic Properties

description

Description
A description for this SCIM Sub Resource Type Handler
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

enabled

Description
Indicates whether the handler is enabled. If a handler is not enabled, then operations using this handler will not be processed.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

endpoint (Read-Only)

Description
The HTTP addressable endpoint of this SCIM Sub Resource Type Handler relative to the base resource URL (i.e. '/scim/v2/users/1234'). Do not include a leading '/'.
Default Value
None
Allowed Values
A HTTP addressable endpoint consisting only of letters, digits, '_' and '-' characters.
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 SCIM Sub Resource Type Handler.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sdk.scim2.api.SCIMSubResourceTypeHandler
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 SCIM Sub Resource Type 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 SCIM Sub Resource Type Handlers:

dsconfig list-scim-sub-resource-type-handlers
     [--property {propertyName}] ...

To view the configuration for an existing SCIM Sub Resource Type Handler:

dsconfig get-scim-sub-resource-type-handler-prop
     --handler-name {name}
     --type-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing SCIM Sub Resource Type Handler:

dsconfig set-scim-sub-resource-type-handler-prop
     --handler-name {name}
     --type-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Third Party SCIM Sub Resource Type Handler:

dsconfig create-scim-sub-resource-type-handler
     --handler-name {name}
     --type-name {name}
     --type third-party
     --set enabled:{propertyValue}
     --set endpoint:{propertyValue}
     --set extension-class:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing SCIM Sub Resource Type Handler:

dsconfig delete-scim-sub-resource-type-handler
     --handler-name {name}
     --type-name {name}