Jump to

• Request
• Response

Add, Search, Compare or Delete Gateway Domain

post

/rest/v1/admin

Add, Search, Compare or Delete Gateway Domain

Request

Supported Media Types

• application/json

Body ()

Gateway Domain that needs to be created

Root Schema : Gateway Domain POSTRequest

Type: object

Show Source

• assertion(optional): string
  Assertion string for the LDAP compare operation. Note: To be used only while performing LDAP compare operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.
• attributes(optional): object Gateway Domain Properties
• base(optional): string
  Search Base DN to be used for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest. It is also mandatory for such operation
• controls(optional): array controls
  LDAP controls to be sent to server for the LDAP operation.
• dn(optional): string
  LDAP DN of the entry to be created or deleted or compared. Note: To be used only while performing LDAP add, delete or compare operations, i.e, if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest, urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest or urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.It is mandatory for such operations.
• filter(optional): string
  Search filter for the LDAP search operation. Should follow LDAP search filter syntax. Note: To be used only while performing LDAP search operation using POST request, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
• msgType: string
  Allowed Values: [ "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest" ]

  The REST message type
• requiredAttributes(optional): array requiredAttributes
  List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
• scope(optional): string
  Allowed Values: [ "base", "sub", "one" ]

  Scope for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.

{
    "type":"object",
    "required":[
        "msgType"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest"
            ]
        },
        "dn":{
            "description":"LDAP DN of the entry to be created or deleted or compared. Note: To be used only while performing LDAP add, delete or compare operations, i.e, if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest, urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest or urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.It is mandatory for such operations.",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/Gateway Domain Properties"
        },
        "base":{
            "description":"Search Base DN to be used for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest. It is also mandatory for such operation",
            "type":"string"
        },
        "scope":{
            "description":"Scope for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"string",
            "enum":[
                "base",
                "sub",
                "one"
            ]
        },
        "filter":{
            "description":"Search filter for the LDAP search operation. Should follow LDAP search filter syntax. Note: To be used only while performing LDAP search operation using POST request, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"string"
        },
        "requiredAttributes":{
            "description":"List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for the LDAP operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "assertion":{
            "description":"Assertion string for the LDAP compare operation. Note: To be used only while performing LDAP compare operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.",
            "type":"string"
        }
    }
}

Nested Schema : Gateway Domain Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-base-dn(optional): string
  Read Only: true

  Specifies the base DN of the replicated data.
• ds-cfg-changetime-heartbeat-interval(optional): string
  Default Value: 1000ms

  Specifies the heart-beat interval that the Replication Gateway will use when sending its local change time to the Replication Server.
• ds-cfg-dscc-address(optional): string
  Read Only: true

  Specifies the host name and port number where the Oracle Directory Service Control Center Registry is deployed.
• ds-cfg-dscc-admin-dn(optional): string
  Read Only: true

  Default Value: cn=admin,cn=Administrators,cn=dscc

  The Directory Service Manager user name used to authenticate through the Oracle Directory Service Control Center.
• ds-cfg-dsee-auth-protocol(optional): string
  Default Value: clear

  Allowed Values: [ "clear", "ssl-client", "ssl-simple" ]

  Specifies the behavior that the backend should use when processing write operations.
• ds-cfg-dsee-bind-dn(optional): string
  Default Value: cn=replication manager,cn=replication,cn=config

  Attribute specifying which bind dn is to be used to connect the DSEE consumer.
• ds-cfg-dsee-group-size(optional): integer(int32)
  Default Value: 10

  Specifies the group size that the Replication Gateway will use when communicating with a DSEE LDAP Server using the DSEE replication transport protocol.
• ds-cfg-dsee-purge-delay(optional): string
  Default Value: 604800s

  Specifies in seconds the purge delay defined on the DSEE server this replication gateway is connected to.
• ds-cfg-dsee-server(optional): string
  Specifies the address of the DSEE Replication Server within the Gateway Domain to which the Replication Gateway Server should try to connect and update.
• ds-cfg-dsee-ssl-rsa-cert-name(optional): string
  Default Value: server-cert

  Attribute specifying which certificate alias to send to the DSEE Consumer while using client authentication
• ds-cfg-dsee-user-password(optional): string
  The password used to authenticate the Replication Gateway by the DSEE Replication Servers.
• ds-cfg-dsee-window-size(optional): integer(int32)
  Default Value: 100

  Specifies the window size that the Replication Gateway will use when communicating with a DSEE LDAP Server using the DSEE replication transport protocol.
• ds-cfg-group-id(optional): integer(int32)
  Default Value: 1

  The group id associated with this replicated domain.
• ds-cfg-handshake-timeout(optional): string
  Default Value: 4000ms

  Specifies the handshake-timeout interval for the handshake between the replication servers.
• ds-cfg-heartbeat-interval(optional): string
  Default Value: 10000ms

  Specifies the heart-beat interval that the Directory Server will use when communicating with Replication Servers.
• ds-cfg-key-manager-provider(optional): string
  Default Value: JKS

  Specifies the name of the key manager that should be used with this Gateway Domain .
• ds-cfg-repl-bind-dn(optional): array ds-cfg-repl-bind-dn
  Allowed replication manager DN(s) to bind for replication purpose.
• ds-cfg-replicate-oud-changes(optional): boolean
  Default Value: true

  Indicates whether the Gateway Domain is replicating changes from the Oracle Unified Directory topology. If set to FALSE, only DSEE updates are propagated through the gateway.
• ds-cfg-replication-server: array ds-cfg-replication-server
  Specifies the addresses of the Replication Servers within the Gateway Domain to which the Directory Server should try to connect at startup time.
• ds-cfg-server-id(optional): integer(int32)
  Read Only: true

  Specifies a unique identifier for the Directory Server within the Gateway Domain.
• ds-cfg-trust-manager-provider(optional): string
  Default Value: JKS

  Specifies the name of the trust manager that should be used with the Gateway Domain .
• ds-cfg-window-size(optional): integer(int32)
  Default Value: 100

  Specifies the window size that the Directory Server will use when communicating with Replication Servers.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-replication-server"
    ],
    "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-heartbeat-interval":{
            "description":"Specifies the heart-beat interval that the Directory Server will use when communicating with Replication Servers. ",
            "readOnly":false,
            "default":"10000ms",
            "type":"string"
        },
        "ds-cfg-group-id":{
            "description":"The group id associated with this replicated domain. ",
            "readOnly":false,
            "default":1,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-dsee-server":{
            "description":"Specifies the address of the DSEE Replication Server within the Gateway Domain to which the Replication Gateway Server should try to connect and update. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-dsee-bind-dn":{
            "description":"Attribute specifying which bind dn is to be used to connect the DSEE consumer. ",
            "readOnly":false,
            "default":"cn=replication manager,cn=replication,cn=config",
            "type":"string"
        },
        "ds-cfg-changetime-heartbeat-interval":{
            "description":"Specifies the heart-beat interval that the Replication Gateway will use when sending its local change time to the Replication Server. ",
            "readOnly":false,
            "default":"1000ms",
            "type":"string"
        },
        "ds-cfg-dsee-user-password":{
            "description":"The password used to authenticate the Replication Gateway by the DSEE Replication Servers. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-repl-bind-dn":{
            "description":"Allowed replication manager DN(s) to bind for replication purpose. ",
            "readOnly":false,
            "default":[
                "cn=replication manager,cn=replication,cn=config"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN of the replicated data. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-key-manager-provider":{
            "description":"Specifies the name of the key manager that should be used with this Gateway Domain . ",
            "readOnly":false,
            "default":"JKS",
            "type":"string"
        },
        "ds-cfg-dsee-group-size":{
            "description":"Specifies the group size that the Replication Gateway will use when communicating with a DSEE LDAP Server using the DSEE replication transport protocol. ",
            "readOnly":false,
            "default":10,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-dscc-admin-dn":{
            "description":"The Directory Service Manager user name used to authenticate through the Oracle Directory Service Control Center. ",
            "readOnly":true,
            "default":"cn=admin,cn=Administrators,cn=dscc",
            "type":"string"
        },
        "ds-cfg-trust-manager-provider":{
            "description":"Specifies the name of the trust manager that should be used with the Gateway Domain . ",
            "readOnly":false,
            "default":"JKS",
            "type":"string"
        },
        "ds-cfg-replicate-oud-changes":{
            "description":"Indicates whether the Gateway Domain is replicating changes from the Oracle Unified Directory topology. If set to FALSE, only DSEE updates are propagated through the gateway. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-dsee-window-size":{
            "description":"Specifies the window size that the Replication Gateway will use when communicating with a DSEE LDAP Server using the DSEE replication transport protocol. ",
            "readOnly":false,
            "default":100,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-dsee-purge-delay":{
            "description":"Specifies in seconds the purge delay defined on the DSEE server this replication gateway is connected to. ",
            "readOnly":false,
            "default":"604800s",
            "type":"string"
        },
        "ds-cfg-dsee-auth-protocol":{
            "description":"Specifies the behavior that the backend should use when processing write operations. ",
            "readOnly":false,
            "default":"clear",
            "type":"string",
            "enum":[
                "clear",
                "ssl-client",
                "ssl-simple"
            ]
        },
        "ds-cfg-replication-server":{
            "description":"Specifies the addresses of the Replication Servers within the Gateway Domain to which the Directory Server should try to connect at startup time. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-dscc-address":{
            "description":"Specifies the host name and port number where the Oracle Directory Service Control Center Registry is deployed. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-handshake-timeout":{
            "description":"Specifies the handshake-timeout interval for the handshake between the replication servers. ",
            "readOnly":false,
            "default":"4000ms",
            "type":"string"
        },
        "ds-cfg-window-size":{
            "description":"Specifies the window size that the Directory Server will use when communicating with Replication Servers. ",
            "readOnly":false,
            "default":100,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-dsee-ssl-rsa-cert-name":{
            "description":"Attribute specifying which certificate alias to send to the DSEE Consumer while using client authentication ",
            "readOnly":false,
            "default":"server-cert",
            "type":"string"
        },
        "ds-cfg-server-id":{
            "description":"Specifies a unique identifier for the Directory Server within the Gateway Domain. ",
            "readOnly":true,
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : controls

Type: array

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

Show Source

• Array of: string

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

Nested Schema : requiredAttributes

Type: array

List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.

Show Source

• Array of: string

{
    "description":"List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

Type: array

Allowed replication manager DN(s) to bind for replication purpose.

Default Value: [ "cn=replication manager,cn=replication,cn=config" ]

Show Source

• Array of: string

{
    "description":"Allowed replication manager DN(s) to bind for replication purpose. ",
    "readOnly":false,
    "default":[
        "cn=replication manager,cn=replication,cn=config"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-replication-server

Type: array

Specifies the addresses of the Replication Servers within the Gateway Domain to which the Directory Server should try to connect at startup time.

Show Source

• Array of: string

{
    "description":"Specifies the addresses of the Replication Servers within the Gateway Domain to which the Directory Server should try to connect at startup time. ",
    "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"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Gateway Domain SuccessResponse

Type: object

Show Source

• compareResult(optional): boolean
  Indicates the result of LDAP compare operation.
• msgType: string
  Allowed Values: [ "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse" ]

  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",
            "type":"string",
            "enum":[
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse"
            ]
        },
        "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/Gateway Domain SearchResultEntry"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• Array of: object Gateway Domain SearchResultEntry

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

Nested Schema : Gateway Domain SearchResultEntry

Type: object

Show Source

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

Nested Schema : Gateway Domain Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-base-dn(optional): string
  Read Only: true

  Specifies the base DN of the replicated data.
• ds-cfg-changetime-heartbeat-interval(optional): string
  Default Value: 1000ms

  Specifies the heart-beat interval that the Replication Gateway will use when sending its local change time to the Replication Server.
• ds-cfg-dscc-address(optional): string
  Read Only: true

  Specifies the host name and port number where the Oracle Directory Service Control Center Registry is deployed.
• ds-cfg-dscc-admin-dn(optional): string
  Read Only: true

  Default Value: cn=admin,cn=Administrators,cn=dscc

  The Directory Service Manager user name used to authenticate through the Oracle Directory Service Control Center.
• ds-cfg-dsee-auth-protocol(optional): string
  Default Value: clear

  Allowed Values: [ "clear", "ssl-client", "ssl-simple" ]

  Specifies the behavior that the backend should use when processing write operations.
• ds-cfg-dsee-bind-dn(optional): string
  Default Value: cn=replication manager,cn=replication,cn=config

  Attribute specifying which bind dn is to be used to connect the DSEE consumer.
• ds-cfg-dsee-group-size(optional): integer(int32)
  Default Value: 10

  Specifies the group size that the Replication Gateway will use when communicating with a DSEE LDAP Server using the DSEE replication transport protocol.
• ds-cfg-dsee-purge-delay(optional): string
  Default Value: 604800s

  Specifies in seconds the purge delay defined on the DSEE server this replication gateway is connected to.
• ds-cfg-dsee-server(optional): string
  Specifies the address of the DSEE Replication Server within the Gateway Domain to which the Replication Gateway Server should try to connect and update.
• ds-cfg-dsee-ssl-rsa-cert-name(optional): string
  Default Value: server-cert

  Attribute specifying which certificate alias to send to the DSEE Consumer while using client authentication
• ds-cfg-dsee-user-password(optional): string
  The password used to authenticate the Replication Gateway by the DSEE Replication Servers.
• ds-cfg-dsee-window-size(optional): integer(int32)
  Default Value: 100

  Specifies the window size that the Replication Gateway will use when communicating with a DSEE LDAP Server using the DSEE replication transport protocol.
• ds-cfg-group-id(optional): integer(int32)
  Default Value: 1

  The group id associated with this replicated domain.
• ds-cfg-handshake-timeout(optional): string
  Default Value: 4000ms

  Specifies the handshake-timeout interval for the handshake between the replication servers.
• ds-cfg-heartbeat-interval(optional): string
  Default Value: 10000ms

  Specifies the heart-beat interval that the Directory Server will use when communicating with Replication Servers.
• ds-cfg-key-manager-provider(optional): string
  Default Value: JKS

  Specifies the name of the key manager that should be used with this Gateway Domain .
• ds-cfg-repl-bind-dn(optional): array ds-cfg-repl-bind-dn
  Allowed replication manager DN(s) to bind for replication purpose.
• ds-cfg-replicate-oud-changes(optional): boolean
  Default Value: true

  Indicates whether the Gateway Domain is replicating changes from the Oracle Unified Directory topology. If set to FALSE, only DSEE updates are propagated through the gateway.
• ds-cfg-replication-server: array ds-cfg-replication-server
  Specifies the addresses of the Replication Servers within the Gateway Domain to which the Directory Server should try to connect at startup time.
• ds-cfg-server-id(optional): integer(int32)
  Read Only: true

  Specifies a unique identifier for the Directory Server within the Gateway Domain.
• ds-cfg-trust-manager-provider(optional): string
  Default Value: JKS

  Specifies the name of the trust manager that should be used with the Gateway Domain .
• ds-cfg-window-size(optional): integer(int32)
  Default Value: 100

  Specifies the window size that the Directory Server will use when communicating with Replication Servers.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-replication-server"
    ],
    "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-heartbeat-interval":{
            "description":"Specifies the heart-beat interval that the Directory Server will use when communicating with Replication Servers. ",
            "readOnly":false,
            "default":"10000ms",
            "type":"string"
        },
        "ds-cfg-group-id":{
            "description":"The group id associated with this replicated domain. ",
            "readOnly":false,
            "default":1,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-dsee-server":{
            "description":"Specifies the address of the DSEE Replication Server within the Gateway Domain to which the Replication Gateway Server should try to connect and update. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-dsee-bind-dn":{
            "description":"Attribute specifying which bind dn is to be used to connect the DSEE consumer. ",
            "readOnly":false,
            "default":"cn=replication manager,cn=replication,cn=config",
            "type":"string"
        },
        "ds-cfg-changetime-heartbeat-interval":{
            "description":"Specifies the heart-beat interval that the Replication Gateway will use when sending its local change time to the Replication Server. ",
            "readOnly":false,
            "default":"1000ms",
            "type":"string"
        },
        "ds-cfg-dsee-user-password":{
            "description":"The password used to authenticate the Replication Gateway by the DSEE Replication Servers. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-repl-bind-dn":{
            "description":"Allowed replication manager DN(s) to bind for replication purpose. ",
            "readOnly":false,
            "default":[
                "cn=replication manager,cn=replication,cn=config"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN of the replicated data. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-key-manager-provider":{
            "description":"Specifies the name of the key manager that should be used with this Gateway Domain . ",
            "readOnly":false,
            "default":"JKS",
            "type":"string"
        },
        "ds-cfg-dsee-group-size":{
            "description":"Specifies the group size that the Replication Gateway will use when communicating with a DSEE LDAP Server using the DSEE replication transport protocol. ",
            "readOnly":false,
            "default":10,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-dscc-admin-dn":{
            "description":"The Directory Service Manager user name used to authenticate through the Oracle Directory Service Control Center. ",
            "readOnly":true,
            "default":"cn=admin,cn=Administrators,cn=dscc",
            "type":"string"
        },
        "ds-cfg-trust-manager-provider":{
            "description":"Specifies the name of the trust manager that should be used with the Gateway Domain . ",
            "readOnly":false,
            "default":"JKS",
            "type":"string"
        },
        "ds-cfg-replicate-oud-changes":{
            "description":"Indicates whether the Gateway Domain is replicating changes from the Oracle Unified Directory topology. If set to FALSE, only DSEE updates are propagated through the gateway. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-dsee-window-size":{
            "description":"Specifies the window size that the Replication Gateway will use when communicating with a DSEE LDAP Server using the DSEE replication transport protocol. ",
            "readOnly":false,
            "default":100,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-dsee-purge-delay":{
            "description":"Specifies in seconds the purge delay defined on the DSEE server this replication gateway is connected to. ",
            "readOnly":false,
            "default":"604800s",
            "type":"string"
        },
        "ds-cfg-dsee-auth-protocol":{
            "description":"Specifies the behavior that the backend should use when processing write operations. ",
            "readOnly":false,
            "default":"clear",
            "type":"string",
            "enum":[
                "clear",
                "ssl-client",
                "ssl-simple"
            ]
        },
        "ds-cfg-replication-server":{
            "description":"Specifies the addresses of the Replication Servers within the Gateway Domain to which the Directory Server should try to connect at startup time. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-dscc-address":{
            "description":"Specifies the host name and port number where the Oracle Directory Service Control Center Registry is deployed. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-handshake-timeout":{
            "description":"Specifies the handshake-timeout interval for the handshake between the replication servers. ",
            "readOnly":false,
            "default":"4000ms",
            "type":"string"
        },
        "ds-cfg-window-size":{
            "description":"Specifies the window size that the Directory Server will use when communicating with Replication Servers. ",
            "readOnly":false,
            "default":100,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-dsee-ssl-rsa-cert-name":{
            "description":"Attribute specifying which certificate alias to send to the DSEE Consumer while using client authentication ",
            "readOnly":false,
            "default":"server-cert",
            "type":"string"
        },
        "ds-cfg-server-id":{
            "description":"Specifies a unique identifier for the Directory Server within the Gateway Domain. ",
            "readOnly":true,
            "type":"integer",
            "format":"int32"
        }
    }
}

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

Type: array

Allowed replication manager DN(s) to bind for replication purpose.

Default Value: [ "cn=replication manager,cn=replication,cn=config" ]

Show Source

• Array of: string

{
    "description":"Allowed replication manager DN(s) to bind for replication purpose. ",
    "readOnly":false,
    "default":[
        "cn=replication manager,cn=replication,cn=config"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-replication-server

Type: array

Specifies the addresses of the Replication Servers within the Gateway Domain to which the Directory Server should try to connect at startup time.

Show Source

• Array of: string

{
    "description":"Specifies the addresses of the Replication Servers within the Gateway Domain to which the Directory Server should try to connect at startup time. ",
    "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"
    }
}

201 Response

Created

Body ()

Root Schema : Gateway Domain ADDResponse

Type: object

Show Source

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

  The REST message type
• searchResultEntries: array searchResultEntries
• 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:AddResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Gateway Domain SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Show Source

• Array of: object Gateway Domain SearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Gateway Domain SearchResultEntry"
    }
}

Nested Schema : Gateway Domain SearchResultEntry

Type: object

Show Source

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

Nested Schema : Gateway Domain Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-base-dn(optional): string
  Read Only: true

  Specifies the base DN of the replicated data.
• ds-cfg-changetime-heartbeat-interval(optional): string
  Default Value: 1000ms

  Specifies the heart-beat interval that the Replication Gateway will use when sending its local change time to the Replication Server.
• ds-cfg-dscc-address(optional): string
  Read Only: true

  Specifies the host name and port number where the Oracle Directory Service Control Center Registry is deployed.
• ds-cfg-dscc-admin-dn(optional): string
  Read Only: true

  Default Value: cn=admin,cn=Administrators,cn=dscc

  The Directory Service Manager user name used to authenticate through the Oracle Directory Service Control Center.
• ds-cfg-dsee-auth-protocol(optional): string
  Default Value: clear

  Allowed Values: [ "clear", "ssl-client", "ssl-simple" ]

  Specifies the behavior that the backend should use when processing write operations.
• ds-cfg-dsee-bind-dn(optional): string
  Default Value: cn=replication manager,cn=replication,cn=config

  Attribute specifying which bind dn is to be used to connect the DSEE consumer.
• ds-cfg-dsee-group-size(optional): integer(int32)
  Default Value: 10

  Specifies the group size that the Replication Gateway will use when communicating with a DSEE LDAP Server using the DSEE replication transport protocol.
• ds-cfg-dsee-purge-delay(optional): string
  Default Value: 604800s

  Specifies in seconds the purge delay defined on the DSEE server this replication gateway is connected to.
• ds-cfg-dsee-server(optional): string
  Specifies the address of the DSEE Replication Server within the Gateway Domain to which the Replication Gateway Server should try to connect and update.
• ds-cfg-dsee-ssl-rsa-cert-name(optional): string
  Default Value: server-cert

  Attribute specifying which certificate alias to send to the DSEE Consumer while using client authentication
• ds-cfg-dsee-user-password(optional): string
  The password used to authenticate the Replication Gateway by the DSEE Replication Servers.
• ds-cfg-dsee-window-size(optional): integer(int32)
  Default Value: 100

  Specifies the window size that the Replication Gateway will use when communicating with a DSEE LDAP Server using the DSEE replication transport protocol.
• ds-cfg-group-id(optional): integer(int32)
  Default Value: 1

  The group id associated with this replicated domain.
• ds-cfg-handshake-timeout(optional): string
  Default Value: 4000ms

  Specifies the handshake-timeout interval for the handshake between the replication servers.
• ds-cfg-heartbeat-interval(optional): string
  Default Value: 10000ms

  Specifies the heart-beat interval that the Directory Server will use when communicating with Replication Servers.
• ds-cfg-key-manager-provider(optional): string
  Default Value: JKS

  Specifies the name of the key manager that should be used with this Gateway Domain .
• ds-cfg-repl-bind-dn(optional): array ds-cfg-repl-bind-dn
  Allowed replication manager DN(s) to bind for replication purpose.
• ds-cfg-replicate-oud-changes(optional): boolean
  Default Value: true

  Indicates whether the Gateway Domain is replicating changes from the Oracle Unified Directory topology. If set to FALSE, only DSEE updates are propagated through the gateway.
• ds-cfg-replication-server: array ds-cfg-replication-server
  Specifies the addresses of the Replication Servers within the Gateway Domain to which the Directory Server should try to connect at startup time.
• ds-cfg-server-id(optional): integer(int32)
  Read Only: true

  Specifies a unique identifier for the Directory Server within the Gateway Domain.
• ds-cfg-trust-manager-provider(optional): string
  Default Value: JKS

  Specifies the name of the trust manager that should be used with the Gateway Domain .
• ds-cfg-window-size(optional): integer(int32)
  Default Value: 100

  Specifies the window size that the Directory Server will use when communicating with Replication Servers.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-replication-server"
    ],
    "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-heartbeat-interval":{
            "description":"Specifies the heart-beat interval that the Directory Server will use when communicating with Replication Servers. ",
            "readOnly":false,
            "default":"10000ms",
            "type":"string"
        },
        "ds-cfg-group-id":{
            "description":"The group id associated with this replicated domain. ",
            "readOnly":false,
            "default":1,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-dsee-server":{
            "description":"Specifies the address of the DSEE Replication Server within the Gateway Domain to which the Replication Gateway Server should try to connect and update. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-dsee-bind-dn":{
            "description":"Attribute specifying which bind dn is to be used to connect the DSEE consumer. ",
            "readOnly":false,
            "default":"cn=replication manager,cn=replication,cn=config",
            "type":"string"
        },
        "ds-cfg-changetime-heartbeat-interval":{
            "description":"Specifies the heart-beat interval that the Replication Gateway will use when sending its local change time to the Replication Server. ",
            "readOnly":false,
            "default":"1000ms",
            "type":"string"
        },
        "ds-cfg-dsee-user-password":{
            "description":"The password used to authenticate the Replication Gateway by the DSEE Replication Servers. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-repl-bind-dn":{
            "description":"Allowed replication manager DN(s) to bind for replication purpose. ",
            "readOnly":false,
            "default":[
                "cn=replication manager,cn=replication,cn=config"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN of the replicated data. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-key-manager-provider":{
            "description":"Specifies the name of the key manager that should be used with this Gateway Domain . ",
            "readOnly":false,
            "default":"JKS",
            "type":"string"
        },
        "ds-cfg-dsee-group-size":{
            "description":"Specifies the group size that the Replication Gateway will use when communicating with a DSEE LDAP Server using the DSEE replication transport protocol. ",
            "readOnly":false,
            "default":10,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-dscc-admin-dn":{
            "description":"The Directory Service Manager user name used to authenticate through the Oracle Directory Service Control Center. ",
            "readOnly":true,
            "default":"cn=admin,cn=Administrators,cn=dscc",
            "type":"string"
        },
        "ds-cfg-trust-manager-provider":{
            "description":"Specifies the name of the trust manager that should be used with the Gateway Domain . ",
            "readOnly":false,
            "default":"JKS",
            "type":"string"
        },
        "ds-cfg-replicate-oud-changes":{
            "description":"Indicates whether the Gateway Domain is replicating changes from the Oracle Unified Directory topology. If set to FALSE, only DSEE updates are propagated through the gateway. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-dsee-window-size":{
            "description":"Specifies the window size that the Replication Gateway will use when communicating with a DSEE LDAP Server using the DSEE replication transport protocol. ",
            "readOnly":false,
            "default":100,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-dsee-purge-delay":{
            "description":"Specifies in seconds the purge delay defined on the DSEE server this replication gateway is connected to. ",
            "readOnly":false,
            "default":"604800s",
            "type":"string"
        },
        "ds-cfg-dsee-auth-protocol":{
            "description":"Specifies the behavior that the backend should use when processing write operations. ",
            "readOnly":false,
            "default":"clear",
            "type":"string",
            "enum":[
                "clear",
                "ssl-client",
                "ssl-simple"
            ]
        },
        "ds-cfg-replication-server":{
            "description":"Specifies the addresses of the Replication Servers within the Gateway Domain to which the Directory Server should try to connect at startup time. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-dscc-address":{
            "description":"Specifies the host name and port number where the Oracle Directory Service Control Center Registry is deployed. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-handshake-timeout":{
            "description":"Specifies the handshake-timeout interval for the handshake between the replication servers. ",
            "readOnly":false,
            "default":"4000ms",
            "type":"string"
        },
        "ds-cfg-window-size":{
            "description":"Specifies the window size that the Directory Server will use when communicating with Replication Servers. ",
            "readOnly":false,
            "default":100,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-dsee-ssl-rsa-cert-name":{
            "description":"Attribute specifying which certificate alias to send to the DSEE Consumer while using client authentication ",
            "readOnly":false,
            "default":"server-cert",
            "type":"string"
        },
        "ds-cfg-server-id":{
            "description":"Specifies a unique identifier for the Directory Server within the Gateway Domain. ",
            "readOnly":true,
            "type":"integer",
            "format":"int32"
        }
    }
}

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

Type: array

Allowed replication manager DN(s) to bind for replication purpose.

Default Value: [ "cn=replication manager,cn=replication,cn=config" ]

Show Source

• Array of: string

{
    "description":"Allowed replication manager DN(s) to bind for replication purpose. ",
    "readOnly":false,
    "default":[
        "cn=replication manager,cn=replication,cn=config"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-replication-server

Type: array

Specifies the addresses of the Replication Servers within the Gateway Domain to which the Directory Server should try to connect at startup time.

Show Source

• Array of: string

{
    "description":"Specifies the addresses of the Replication Servers within the Gateway Domain to which the Directory Server should try to connect at startup time. ",
    "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"
    }
}

204 Response

No content

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