Jump to

• Request
• Response

Modify a Network Group by DN

patch

/rest/v1/admin/{dn}

Modify a Network Group by DN

Request

Supported Media Types

• application/json

Path Parameters

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

Body ()

Network Group 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 : Network Group 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/Network Group SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• [0]: object Network Group SearchResultEntry

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

Nested Schema : Network Group SearchResultEntry

Type: object

Show Source

• attributes: object Network Group 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/Network Group Properties"
        }
    }
}

Nested Schema : Network Group Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-allowed-auth-method(optional): array ds-cfg-allowed-auth-method
  Specifies a set of allowed authorization methods that clients must use in order to establish connections to this Network Group.
• ds-cfg-allowed-bind-dn(optional): array ds-cfg-allowed-bind-dn
  Specifies a set of bind DN patterns that determine the clients that are allowed to establish connections to this Network Group.
• ds-cfg-allowed-bind-id(optional): array ds-cfg-allowed-bind-id
  Specifies a set of bind id patterns that determine the clients that are allowed to establish connections to this Network Group.
• ds-cfg-allowed-client(optional): array ds-cfg-allowed-client
  Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Network Group.
• ds-cfg-allowed-port(optional): array ds-cfg-allowed-port
  Specifies a set of allowed port numbers that clients must use in order to establish connections to this Network Group.
• ds-cfg-allowed-protocol(optional): array ds-cfg-allowed-protocol
  Specifies a set of allowed supported protocols that clients must use in order to establish connections to this Network Group.
• ds-cfg-certificate-mapper(optional): string
  Specifies the name of the certificate mapper that should be used to match client certificates to user entries.
• ds-cfg-denied-client(optional): array ds-cfg-denied-client
  Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Network Group.
• ds-cfg-enabled: boolean
  Indicates whether the Network Group is enabled for use in the server.
• ds-cfg-generic-identity-mapper(optional): array ds-cfg-generic-identity-mapper
  Specifies a set of identity mappers that will be used by Network Group for mapping an identity while performing SIMPLE, non-GSSAPI SASL bind requests and proxy authorization controls.
• ds-cfg-gssapi-identity-mapper(optional): array ds-cfg-gssapi-identity-mapper
  Specifies a set of identity mappers that will be used by Network Group for mapping an identity while performing GSSAPI/SASL bind requests.
• ds-cfg-is-security-mandatory(optional): boolean
  Default Value: false

  Specifies whether or not a secured client connection is required in order for clients to establish connections to this Network Group.
• ds-cfg-priority: integer(int32)
  Specifies the priority for this Network Group.
• ds-cfg-relocated-rootdse-dn(optional): string
  Default Value:

  Specifies the DN of the entry that contains the Root DSE. If the parameter is not defined (default) then the null suffix ("") is used.
• ds-cfg-relocated-rootdse-workflow-element(optional): string
  Specifies the name of the workflow element to use to get a relocated root DSE entry. If the parameter is not defined (default) then the root DSE entry of the current server is returned.
• ds-cfg-workflow(optional): array ds-cfg-workflow
  Specifies a set of workflows which should be accessible from this Network Group .
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-priority",
        "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-allowed-bind-id":{
            "description":"Specifies a set of bind id patterns that determine the clients that are allowed to establish connections to this Network Group. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allowed-port":{
            "description":"Specifies a set of allowed port numbers that clients must use in order to establish connections to this Network Group. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-workflow":{
            "description":"Specifies a set of workflows which should be accessible from this Network Group . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-relocated-rootdse-workflow-element":{
            "description":"Specifies the name of the workflow element to use to get a relocated root DSE entry. If the parameter is not defined (default) then the root DSE entry of the current server is returned. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-generic-identity-mapper":{
            "description":"Specifies a set of identity mappers that will be used by Network Group for mapping an identity while performing SIMPLE, non-GSSAPI SASL bind requests and proxy authorization controls. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-certificate-mapper":{
            "description":"Specifies the name of the certificate mapper that should be used to match client certificates to user entries. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-priority":{
            "description":"Specifies the priority for this Network Group. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Network Group is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-gssapi-identity-mapper":{
            "description":"Specifies a set of identity mappers that will be used by Network Group for mapping an identity while performing GSSAPI/SASL bind requests. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allowed-bind-dn":{
            "description":"Specifies a set of bind DN patterns that determine the clients that are allowed to establish connections to this Network Group. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-denied-client":{
            "description":"Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Network Group. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-is-security-mandatory":{
            "description":"Specifies whether or not a secured client connection is required in order for clients to establish connections to this Network Group. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-allowed-protocol":{
            "description":"Specifies a set of allowed supported protocols that clients must use in order to establish connections to this Network Group. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "ldap",
                "ldaps"
            ]
        },
        "ds-cfg-relocated-rootdse-dn":{
            "description":"Specifies the DN of the entry that contains the Root DSE. If the parameter is not defined (default) then the null suffix (\"\") is used. ",
            "readOnly":false,
            "default":"",
            "type":"string"
        },
        "ds-cfg-allowed-auth-method":{
            "description":"Specifies a set of allowed authorization methods that clients must use in order to establish connections to this Network Group. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "anonymous",
                "sasl",
                "simple"
            ]
        },
        "ds-cfg-allowed-client":{
            "description":"Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Network Group. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ds-cfg-allowed-auth-method

Type: array

Specifies a set of allowed authorization methods that clients must use in order to establish connections to this Network Group.

Allowed Values: [ "anonymous", "sasl", "simple" ]

Show Source

• [0]: string

{
    "description":"Specifies a set of allowed authorization methods that clients must use in order to establish connections to this Network Group. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "anonymous",
        "sasl",
        "simple"
    ]
}

Nested Schema : ds-cfg-allowed-bind-dn

Type: array

Specifies a set of bind DN patterns that determine the clients that are allowed to establish connections to this Network Group.

Show Source

• [0]: string

{
    "description":"Specifies a set of bind DN patterns that determine the clients that are allowed to establish connections to this Network Group. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-allowed-bind-id

Type: array

Specifies a set of bind id patterns that determine the clients that are allowed to establish connections to this Network Group.

Show Source

• [0]: string

{
    "description":"Specifies a set of bind id patterns that determine the clients that are allowed to establish connections to this Network Group. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-allowed-client

Type: array

Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Network Group.

Show Source

• [0]: string

{
    "description":"Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Network Group. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-allowed-port

Type: array

Specifies a set of allowed port numbers that clients must use in order to establish connections to this Network Group.

Show Source

• [0]: string

{
    "description":"Specifies a set of allowed port numbers that clients must use in order to establish connections to this Network Group. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-allowed-protocol

Type: array

Specifies a set of allowed supported protocols that clients must use in order to establish connections to this Network Group.

Allowed Values: [ "ldap", "ldaps" ]

Show Source

• [0]: string

{
    "description":"Specifies a set of allowed supported protocols that clients must use in order to establish connections to this Network Group. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "ldap",
        "ldaps"
    ]
}

Nested Schema : ds-cfg-denied-client

Type: array

Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Network Group.

Show Source

• [0]: string

{
    "description":"Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Network Group. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-generic-identity-mapper

Type: array

Specifies a set of identity mappers that will be used by Network Group for mapping an identity while performing SIMPLE, non-GSSAPI SASL bind requests and proxy authorization controls.

Show Source

• [0]: string

{
    "description":"Specifies a set of identity mappers that will be used by Network Group for mapping an identity while performing SIMPLE, non-GSSAPI SASL bind requests and proxy authorization controls. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-gssapi-identity-mapper

Type: array

Specifies a set of identity mappers that will be used by Network Group for mapping an identity while performing GSSAPI/SASL bind requests.

Show Source

• [0]: string

{
    "description":"Specifies a set of identity mappers that will be used by Network Group for mapping an identity while performing GSSAPI/SASL bind requests. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-workflow

Type: array

Specifies a set of workflows which should be accessible from this Network Group .

Show Source

• [0]: string

{
    "description":"Specifies a set of workflows which should be accessible from this Network Group . ",
    "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