Jump to

• Request
• Response

Modify a Proxy LDAP Workflow Element by DN

patch

/rest/v1/admin/{dn}

Modify a Proxy LDAP Workflow Element by DN

Request

Supported Media Types

• application/json

Path Parameters

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

Body ()

Proxy LDAP Workflow Element 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

• [0]: 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

• [0]: 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

• [0]: 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 : Proxy LDAP Workflow Element 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/Proxy LDAP Workflow Element SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• [0]: object Proxy LDAP Workflow Element SearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Proxy LDAP Workflow Element SearchResultEntry"
    }
}

Nested Schema : Proxy LDAP Workflow Element SearchResultEntry

Type: object

Show Source

• attributes: object Proxy LDAP Workflow Element 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/Proxy LDAP Workflow Element Properties"
        }
    }
}

Nested Schema : Proxy LDAP Workflow Element Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-client-cred-mode: string
  Allowed Values: [ "use-client-identity", "use-proxy-auth", "use-specific-identity" ]

  Specifies the way the proxy server binds to the remote LDAP server.
• ds-cfg-enabled: boolean
  Indicates whether the Workflow Element is enabled for use in the server.
• ds-cfg-exclude-list(optional): array ds-cfg-exclude-list
  The list contains a set of DNs. If the client bind DN is a descendant of one DNs on the exclude list, then the authentication against the remote server will be performed using the proxy credentials, regardless of the content of the include list.
• ds-cfg-include-list(optional): array ds-cfg-include-list
  The list contains a set of DNs. If the client bind DN is a descendant of one of the DNs in the list, or if the list is empty, then the client credentials can be used to perform authentication against the remote server (as long as the client bind DN is not a descendant of any DN on the exclude list). If the never-bind flag is disabled then a silent-bind is performed for the authentication. If the never-bind flag is enabled, the user's entry is retrieved from the remote server and the credentials are checked locally.
• ds-cfg-java-class: string
  Default Value: com.sun.dps.server.workflowelement.proxyldap.ProxyLdapWorkflowElement

  Specifies the fully-qualified name of the Java class that provides the Proxy LDAP Workflow Element implementation.
• ds-cfg-ldap-server-extension: string
  Identifies the LDAP server extension configured for this Proxy LDAP Workflow Element.
• ds-cfg-log-silent-bind-response-controls(optional): boolean
  Default Value: false

  Indicates whether the logging of the silent-bind response controls is enabled.
• ds-cfg-never-bind(optional): boolean
  Default Value: false

  Indicates whether the never-bind flag is enabled.
• ds-cfg-never-bind-user-password-attribute(optional): string
  Default Value: userPassword

  This attribute defines the description of the attribute that identifies the user's credentials on the remote server. It is relevant only when the never-bind flag is enabled. When this attribute is omitted the default value "userPassword" is used instead.
• ds-cfg-remote-ldap-server-bind-dn(optional): string
  DN which will be used to connect to a remote server. This DN must exist on the remote server.
• ds-cfg-remote-ldap-server-bind-password(optional): string
  Password which will be used to connect to the remote server.
• ds-cfg-remote-ldap-server-bind-password-file(optional): string
  File which contains the password which will be used to connect to the remote server.
• ds-cfg-remote-root-dn(optional): string
  The root DN which will be used to perform internal operations on a remote server. This DN must exist on the remote server. The value "" denotes the anonymous credentials. If "" is provided then the remote-ldap-server-bind-password property is ignored.
• ds-cfg-remote-root-password(optional): string
  Password which will be used by the root DN to connect to the remote server.
• ds-cfg-use-proxy-auth(optional): boolean
  Default Value: false

  This flag indicates whether the LDAP connector can use the proxy authorization control.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-client-cred-mode",
        "ds-cfg-ldap-server-extension",
        "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 Proxy LDAP Workflow Element implementation. ",
            "readOnly":false,
            "default":"com.sun.dps.server.workflowelement.proxyldap.ProxyLdapWorkflowElement",
            "type":"string"
        },
        "ds-cfg-remote-ldap-server-bind-dn":{
            "description":"DN which will be used to connect to a remote server. This DN must exist on the remote server. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-never-bind":{
            "description":"Indicates whether the never-bind flag is enabled. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-never-bind-user-password-attribute":{
            "description":"This attribute defines the description of the attribute that identifies the user's credentials on the remote server. It is relevant only when the never-bind flag is enabled. When this attribute is omitted the default value \"userPassword\" is used instead. ",
            "readOnly":false,
            "default":"userPassword",
            "type":"string"
        },
        "ds-cfg-use-proxy-auth":{
            "description":"This flag indicates whether the LDAP connector can use the proxy authorization control. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-include-list":{
            "description":"The list contains a set of DNs. If the client bind DN is a descendant of one of the DNs in the list, or if the list is empty, then the client credentials can be used to perform authentication against the remote server (as long as the client bind DN is not a descendant of any DN on the exclude list). If the never-bind flag is disabled then a silent-bind is performed for the authentication. If the never-bind flag is enabled, the user's entry is retrieved from the remote server and the credentials are checked locally. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-client-cred-mode":{
            "description":"Specifies the way the proxy server binds to the remote LDAP server. ",
            "readOnly":false,
            "type":"string",
            "enum":[
                "use-client-identity",
                "use-proxy-auth",
                "use-specific-identity"
            ]
        },
        "ds-cfg-remote-ldap-server-bind-password-file":{
            "description":"File which contains the password which will be used to connect to the remote server. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-remote-ldap-server-bind-password":{
            "description":"Password which will be used to connect to the remote server. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-remote-root-password":{
            "description":"Password which will be used by the root DN to connect to the remote server. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-ldap-server-extension":{
            "description":"Identifies the LDAP server extension configured for this Proxy LDAP Workflow Element. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-remote-root-dn":{
            "description":"The root DN which will be used to perform internal operations on a remote server. This DN must exist on the remote server. The value \"\" denotes the anonymous credentials. If \"\" is provided then the remote-ldap-server-bind-password property is ignored. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-log-silent-bind-response-controls":{
            "description":"Indicates whether the logging of the silent-bind response controls is enabled. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-exclude-list":{
            "description":"The list contains a set of DNs. If the client bind DN is a descendant of one DNs on the exclude list, then the authentication against the remote server will be performed using the proxy credentials, regardless of the content of the include list. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ds-cfg-exclude-list

Type: array

The list contains a set of DNs. If the client bind DN is a descendant of one DNs on the exclude list, then the authentication against the remote server will be performed using the proxy credentials, regardless of the content of the include list.

Show Source

• [0]: string

{
    "description":"The list contains a set of DNs. If the client bind DN is a descendant of one DNs on the exclude list, then the authentication against the remote server will be performed using the proxy credentials, regardless of the content of the include list. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-include-list

Type: array

The list contains a set of DNs. If the client bind DN is a descendant of one of the DNs in the list, or if the list is empty, then the client credentials can be used to perform authentication against the remote server (as long as the client bind DN is not a descendant of any DN on the exclude list). If the never-bind flag is disabled then a silent-bind is performed for the authentication. If the never-bind flag is enabled, the user's entry is retrieved from the remote server and the credentials are checked locally.

Show Source

• [0]: string

{
    "description":"The list contains a set of DNs. If the client bind DN is a descendant of one of the DNs in the list, or if the list is empty, then the client credentials can be used to perform authentication against the remote server (as long as the client bind DN is not a descendant of any DN on the exclude list). If the never-bind flag is disabled then a silent-bind is performed for the authentication. If the never-bind flag is enabled, the user's entry is retrieved from the remote server and the credentials are checked locally. ",
    "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"
    }
}

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