Jump to

• Request
• Response

Find Union Partition by DN

get

/rest/v1/admin/{dn}

Returns an Union Partition 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 : Union Partition 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/Union Partition SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• [0]: object Union Partition SearchResultEntry

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

Nested Schema : Union Partition SearchResultEntry

Type: object

Show Source

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

Nested Schema : Union Partition Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-allowed-operations(optional): array ds-cfg-allowed-operations
  The operation types allowed in this partition.
• ds-cfg-black-list-attributes(optional): array ds-cfg-black-list-attributes
  The list of attributes of DN syntax that must NOT be transformed.
• ds-cfg-priority(optional): integer(int32)
  Default Value: 10

  The priority of the partition.
• ds-cfg-relative-base-dn(optional): string
  Default Value:

  The relative part of the partition base DN.
• ds-cfg-source-base-dn(optional): string
  Default Value:

  The base DN for the source DIT.
• ds-cfg-white-list-attributes(optional): array ds-cfg-white-list-attributes
  The list of attributes of DN syntax that must be transformed.
• ds-cfg-workflow-element: string
  The partition workflow element.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-workflow-element"
    ],
    "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-white-list-attributes":{
            "description":"The list of attributes of DN syntax that must be transformed. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-source-base-dn":{
            "description":"The base DN for the source DIT. ",
            "readOnly":false,
            "default":"",
            "type":"string"
        },
        "ds-cfg-workflow-element":{
            "description":"The partition workflow element. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-relative-base-dn":{
            "description":"The relative part of the partition base DN. ",
            "readOnly":false,
            "default":"",
            "type":"string"
        },
        "ds-cfg-priority":{
            "description":"The priority of the partition. ",
            "readOnly":false,
            "default":10,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-allowed-operations":{
            "description":"The operation types allowed in this partition. ",
            "readOnly":false,
            "default":[
                "search",
                "bind",
                "add",
                "delete",
                "modify",
                "modifyDN",
                "compare",
                "extended"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "add",
                "bind",
                "compare",
                "delete",
                "extended",
                "modify",
                "modifydn",
                "search"
            ]
        },
        "ds-cfg-black-list-attributes":{
            "description":"The list of attributes of DN syntax that must NOT be transformed. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ds-cfg-allowed-operations

Type: array

The operation types allowed in this partition.

Default Value: [ "search", "bind", "add", "delete", "modify", "modifyDN", "compare", "extended" ]

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

Show Source

• [0]: string

{
    "description":"The operation types allowed in this partition. ",
    "readOnly":false,
    "default":[
        "search",
        "bind",
        "add",
        "delete",
        "modify",
        "modifyDN",
        "compare",
        "extended"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "add",
        "bind",
        "compare",
        "delete",
        "extended",
        "modify",
        "modifydn",
        "search"
    ]
}

Nested Schema : ds-cfg-black-list-attributes

Type: array

The list of attributes of DN syntax that must NOT be transformed.

Show Source

• [0]: string

{
    "description":"The list of attributes of DN syntax that must NOT be transformed. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-white-list-attributes

Type: array

The list of attributes of DN syntax that must be transformed.

Show Source

• [0]: string

{
    "description":"The list of attributes of DN syntax that must be transformed. ",
    "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