Jump to

• Request
• Response

Modify a Match And Replace Identity Mapper by DN

patch

/rest/v1/admin/{dn}

Modify a Match And Replace Identity Mapper by DN

Request

Supported Media Types

• application/json

Path Parameters

• dn: string
  LDAP DN of the entry to be modified

Body ()

Match And Replace Identity Mapper that needs to be modified

Root Schema : PatchRequest

Type: object

Show Source

• controls(optional): array controls
  LDAP controls to be sent to server for LDAP modify operation.
• msgType: string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest

  The REST message type
• operations: array operations
  Modifications (Patch operations) to be performed on the entry.

{
    "type":"object",
    "required":[
        "msgType",
        "operations"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest",
            "type":"string"
        },
        "operations":{
            "type":"array",
            "description":"Modifications (Patch operations) to be performed on the entry.",
            "items":{
                "$ref":"#/definitions/PatchOperation"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for LDAP modify operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : controls

Type: array

LDAP controls to be sent to server for LDAP modify operation.

Show Source

• Array of: string

{
    "description":"LDAP controls to be sent to server for LDAP modify operation.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : operations

Type: array

Modifications (Patch operations) to be performed on the entry.

Show Source

• Array of: object PatchOperation

{
    "type":"array",
    "description":"Modifications (Patch operations) to be performed on the entry.",
    "items":{
        "$ref":"#/definitions/PatchOperation"
    }
}

Nested Schema : PatchOperation

Type: object

Show Source

• attribute: string
  The entry attribute to be modified.
• opType: string
  Allowed Values: [ "add", "delete", "replace", "increment" ]

  The type of the Patch Operation.
• values(optional): array values
  The attribute values to be updated.

{
    "type":"object",
    "required":[
        "opType",
        "attribute"
    ],
    "properties":{
        "opType":{
            "description":"The type of the Patch Operation.",
            "type":"string",
            "enum":[
                "add",
                "delete",
                "replace",
                "increment"
            ]
        },
        "attribute":{
            "type":"string",
            "description":"The entry attribute to be modified."
        },
        "values":{
            "type":"array",
            "description":"The attribute values to be updated.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : values

Type: array

The attribute values to be updated.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The attribute values to be updated.",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Match And Replace Identity Mapper PatchSuccessResponse

Type: object

Show Source

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

  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:ModifyResponse",
            "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/Match And Replace Identity Mapper SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• Array of: object Match And Replace Identity Mapper SearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Match And Replace Identity Mapper SearchResultEntry"
    }
}

Nested Schema : Match And Replace Identity Mapper SearchResultEntry

Type: object

Show Source

• attributes: object Match And Replace Identity Mapper 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/Match And Replace Identity Mapper Properties"
        }
    }
}

Nested Schema : Match And Replace Identity Mapper Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-enabled: boolean
  Indicates whether the Identity Mapper is enabled for use.
• ds-cfg-java-class: string
  Default Value: org.opends.server.extensions.MatchAndReplaceIdentityMapper

  Specifies the fully-qualified name of the Java class that provides the Match And Replace Identity Mapper implementation.
• ds-cfg-match-attribute: array ds-cfg-match-attribute
  Specifies the name or OID of the attribute whose value should match the provided identifier string after it has been processed by the associated regular expression.
• ds-cfg-match-base-dn(optional): array ds-cfg-match-base-dn
  Specifies the base DN(s) that should be used when performing searches to map the provided ID string to a user entry. If multiple values are given, searches are performed below all the specified base DNs.
• ds-cfg-match-pattern: string
  Specifies the regular expression pattern that is used to identify an entry that Identity Mapper applies to.
• ds-cfg-priority(optional): integer(int32)
  Default Value: 1

  Specifies the priority for this Identity Mapper.
• ds-cfg-replace-pattern(optional): string
  Specifies the replacement pattern that should be used for substrings in the ID string that match the provided regular expression pattern.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-match-attribute",
        "ds-cfg-match-pattern",
        "ds-cfg-enabled"
    ],
    "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 Match And Replace Identity Mapper implementation. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.MatchAndReplaceIdentityMapper",
            "type":"string"
        },
        "ds-cfg-match-base-dn":{
            "description":"Specifies the base DN(s) that should be used when performing searches to map the provided ID string to a user entry. If multiple values are given, searches are performed below all the specified base DNs. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-replace-pattern":{
            "description":"Specifies the replacement pattern that should be used for substrings in the ID string that match the provided regular expression pattern. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-match-attribute":{
            "description":"Specifies the name or OID of the attribute whose value should match the provided identifier string after it has been processed by the associated regular expression. ",
            "readOnly":false,
            "default":[
                "uid"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-match-pattern":{
            "description":"Specifies the regular expression pattern that is used to identify an entry that Identity Mapper applies to. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-priority":{
            "description":"Specifies the priority for this Identity Mapper. ",
            "readOnly":false,
            "default":1,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Identity Mapper is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

Nested Schema : ds-cfg-match-attribute

Type: array

Specifies the name or OID of the attribute whose value should match the provided identifier string after it has been processed by the associated regular expression.

Default Value: [ "uid" ]

Show Source

• Array of: string

{
    "description":"Specifies the name or OID of the attribute whose value should match the provided identifier string after it has been processed by the associated regular expression. ",
    "readOnly":false,
    "default":[
        "uid"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-match-base-dn

Type: array

Specifies the base DN(s) that should be used when performing searches to map the provided ID string to a user entry. If multiple values are given, searches are performed below all the specified base DNs.

Show Source

• Array of: string

{
    "description":"Specifies the base DN(s) that should be used when performing searches to map the provided ID string to a user entry. If multiple values are given, searches are performed below all the specified base DNs. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

• Array of: string

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

400 Response

ERROR

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