Directory Proxy Server Documentation Index
Configuration Reference Home

Suppress Attribute Proxy Transformation

The Suppress Attribute Proxy Transformation may be used to prevent a specified attribute from being included in search result entries returned to the client. It may optionally cause the Directory Proxy Server to reject any request which targets the specified attribute.

Parent Component
Properties
dsconfig Usage

Parent Component

The Suppress Attribute Proxy Transformation component inherits from the Proxy Transformation

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ request-criteria
↓ target-attribute
↓ reject-request-type

Basic Properties

description

Description
A description for this Proxy Transformation
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 this proxy transformation is enabled for use in the server.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

request-criteria

Description
Criteria indicating the set of operations for which the transformation will be invoked.
Default Value
This Proxy Transformation will be invoked for all operations.
Allowed Values
The DN of any Request Criteria.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

target-attribute

Description
Specifies the name of an attribute that clients should not be allowed to access. Each value may be the name or OID of an attribute type that should be suppressed. If an attribute type name is prefixed with a caret symbol ("^"), then all attributes except the specified type will be suppressed. If multiple target attribute values are provided, then it must not contain some names which are prefixed with "^" and others which are not.
Default Value
None
Allowed Values
A string
Multi-Valued
Yes
Required
Yes
Admin Action Required
None. Modification requires no further action

reject-request-type

Description
Specifies the set of operation request types that should be rejected if the request attempts to target the specified attribute.
Default Value
None
Allowed Values
add - Add requests may be rejected if they include any values for the target attribute.

bind - Bind requests may be rejected if they include any values for the target attribute.

compare - Compare requests may be rejected if they attempt to use the target attribute.

delete - Delete requests may be rejected if they attempt to use the target attribute.

modify - Modify requests may be rejected if they attempt to alter the target attribute.

modify-dn - Modify DN requests may be rejected if the new RDN includes the target attribute.

search - Search requests may be rejected if any filter component references the target attribute.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Proxy Transformations:

dsconfig list-proxy-transformations
     [--property {propertyName}] ...

To view the configuration for an existing Proxy Transformation:

dsconfig get-proxy-transformation-prop
     --transformation-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Proxy Transformation:

dsconfig set-proxy-transformation-prop
     --transformation-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Suppress Attribute Proxy Transformation:

dsconfig create-proxy-transformation
     --transformation-name {name}
     --type suppress-attribute
     --set enabled:{propertyValue}
     --set target-attribute:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Proxy Transformation:

dsconfig delete-proxy-transformation
     --transformation-name {name}