Jump to

• Request
• Response

Find Map Object Class Transformation by DN

get

/rest/v1/admin/{dn}

Returns an Map Object Class Transformation by DN

Request

Supported Media Types

• application/json

Path Parameters

• dn: string
  LDAP DN of the entry to be fetched.

Query Parameters

• attributes: array
  Collection Format: multi

  List of attributes to be fetched for the entry.

  • [0]: string

  {
      "name":"attributes",
      "in":"query",
      "description":"List of attributes to be fetched for the entry.",
      "type":"array",
      "collectionFormat":"multi",
      "items":{
          "type":"string"
      }
  }

• controls: array
  Collection Format: multi

  LDAP controls to be sent to server for search operation.

  • [0]: string

  {
      "name":"controls",
      "in":"query",
      "description":"LDAP controls to be sent to server for search operation.",
      "type":"array",
      "collectionFormat":"multi",
      "items":{
          "type":"string"
      }
  }

• filter: string
  Search filter for the LDAP search operation. Should follow LDAP search filter syntax.
• scope: string
  Scope for the LDAP search operation.

  Allowed Values: [ "base", "sub", "one" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Map Object Class Transformation GetSuccessResponse

Type: object

Show Source

• msgType: string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse

  The REST message type
• searchResultEntries: array searchResultEntries
  Number of search result entries returned after the LDAP operation.
• totalResults: integer(int32)
  Specifies the number of entries created, and returned.

{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "description":"Number of search result entries returned after the LDAP operation.",
            "items":{
                "$ref":"#/definitions/Map Object Class Transformation SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• [0]: object Map Object Class Transformation SearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Map Object Class Transformation SearchResultEntry"
    }
}

Nested Schema : Map Object Class Transformation SearchResultEntry

Type: object

Show Source

• attributes: object Map Object Class Transformation Properties
• dn: string
  LDAP DN of the entry to be created

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/Map Object Class Transformation Properties"
        }
    }
}

Nested Schema : Map Object Class Transformation Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-add-attribute(optional): array ds-cfg-add-attribute
  Add an attribute to the entry during add operation. An optional objectclass name may be specified to add the attribute only for that objectclass.
• ds-cfg-entry-match-filter(optional): string
  Specifies the filter that the entry must match for this transformation to apply.
• ds-cfg-entry-parent-suffix(optional): array ds-cfg-entry-parent-suffix
  Specifies an ascendant of the operation DN for this transformation to apply.
• ds-cfg-excluded-operation(optional): array ds-cfg-excluded-operation
  Specifies operations on which this transformation never apply. This allows to restrict the regular behavior of this transformation.
• ds-cfg-filter-attribute(optional): array ds-cfg-filter-attribute
  Removes an attribute from the entry during add, modify operations and from all returned entries. A conditional objectclass name may be specified to remove the attribute only for that objectclass.
• ds-cfg-filter-objectclass-on-modify(optional): boolean
  Default Value: true

  Remove objectclasses during modify operations.
• ds-cfg-filter-objectclass-on-write(optional): array ds-cfg-filter-objectclass-on-write
  Remove an objectclass during add and modify operations.
• ds-cfg-java-class: string
  Default Value: org.opends.server.core.transformations.attributetransformations.MapObjectClass

  Specifies the fully-qualified name of the Java class that provides the Map Object Class Transformation implementation.
• ds-cfg-map-attribute(optional): array ds-cfg-map-attribute
  Map a client attribute to a source attribute.
• ds-cfg-map-objectclass: array ds-cfg-map-objectclass
  Map a client objectclass to a source objectclass.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-map-objectclass"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-java-class":{
            "description":"Specifies the fully-qualified name of the Java class that provides the Map Object Class Transformation implementation. ",
            "readOnly":false,
            "default":"org.opends.server.core.transformations.attributetransformations.MapObjectClass",
            "type":"string"
        },
        "ds-cfg-add-attribute":{
            "description":"Add an attribute to the entry during add operation. An optional objectclass name may be specified to add the attribute only for that objectclass. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-filter-objectclass-on-modify":{
            "description":"Remove objectclasses during modify operations. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-entry-match-filter":{
            "description":"Specifies the filter that the entry must match for this transformation to apply. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-map-attribute":{
            "description":"Map a client attribute to a source attribute. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-excluded-operation":{
            "description":"Specifies operations on which this transformation never apply. This allows to restrict the regular behavior of this transformation. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "add",
                "compare",
                "delete",
                "extended",
                "modify",
                "modifydn",
                "search"
            ]
        },
        "ds-cfg-entry-parent-suffix":{
            "description":"Specifies an ascendant of the operation DN for this transformation to apply. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-filter-attribute":{
            "description":"Removes an attribute from the entry during add, modify operations and from all returned entries. A conditional objectclass name may be specified to remove the attribute only for that objectclass. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-filter-objectclass-on-write":{
            "description":"Remove an objectclass during add and modify operations. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-map-objectclass":{
            "description":"Map a client objectclass to a source objectclass. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ds-cfg-add-attribute

Type: array

Add an attribute to the entry during add operation. An optional objectclass name may be specified to add the attribute only for that objectclass.

Show Source

• [0]: string

{
    "description":"Add an attribute to the entry during add operation. An optional objectclass name may be specified to add the attribute only for that objectclass. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-entry-parent-suffix

Type: array

Specifies an ascendant of the operation DN for this transformation to apply.

Show Source

• [0]: string

{
    "description":"Specifies an ascendant of the operation DN for this transformation to apply. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-excluded-operation

Type: array

Specifies operations on which this transformation never apply. This allows to restrict the regular behavior of this transformation.

Allowed Values: [ "add", "compare", "delete", "extended", "modify", "modifydn", "search" ]

Show Source

• [0]: string

{
    "description":"Specifies operations on which this transformation never apply. This allows to restrict the regular behavior of this transformation. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "add",
        "compare",
        "delete",
        "extended",
        "modify",
        "modifydn",
        "search"
    ]
}

Nested Schema : ds-cfg-filter-attribute

Type: array

Removes an attribute from the entry during add, modify operations and from all returned entries. A conditional objectclass name may be specified to remove the attribute only for that objectclass.

Show Source

• [0]: string

{
    "description":"Removes an attribute from the entry during add, modify operations and from all returned entries. A conditional objectclass name may be specified to remove the attribute only for that objectclass. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-filter-objectclass-on-write

Type: array

Remove an objectclass during add and modify operations.

Show Source

• [0]: string

{
    "description":"Remove an objectclass during add and modify operations. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-map-attribute

Type: array

Map a client attribute to a source attribute.

Show Source

• [0]: string

{
    "description":"Map a client attribute to a source attribute. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-map-objectclass

Type: array

Map a client objectclass to a source objectclass.

Show Source

• [0]: string

{
    "description":"Map a client objectclass to a source objectclass. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

• [0]: string

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

406 Response

Not Acceptable

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• ldapErrorCode(optional): integer(int32)
  Specifies the LDAP error code returned for the operation.
• message: string
  Error message returned returned for the operation.
• msgType: string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse

  The REST message type

{
    "type":"object",
    "required":[
        "msgType",
        "message"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse",
            "type":"string"
        },
        "message":{
            "description":"Error message returned returned for the operation.",
            "type":"string"
        },
        "ldapErrorCode":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the LDAP error code returned for the operation."
        }
    }
}

Back to Top