Jump to

• Request
• Response

Find REST Server Extension by DN

get

/rest/v1/admin/{dn}

Returns an REST Server Extension 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 : REST Server Extension 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/REST Server Extension SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• [0]: object REST Server Extension SearchResultEntry

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

Nested Schema : REST Server Extension SearchResultEntry

Type: object

Show Source

• attributes: object REST Server Extension 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/REST Server Extension Properties"
        }
    }
}

Nested Schema : REST Server Extension Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-allow-entry-return(optional): boolean
  Default Value: true

  Enables to return an entry after successful ADD, Modify and ModifyDN operations.
• ds-cfg-context-path(optional): string
  Specifies the HTTP context used for all RESTful services
• ds-cfg-enabled: boolean
  Indicates whether the Extension is enabled.
• ds-cfg-end-point(optional): array ds-cfg-end-point
  The HTTP end points that will be available through REST Server Extension .
• ds-cfg-http-authentication-scheme(optional): array ds-cfg-http-authentication-scheme
  The types of authentication scheme that will be used while accepting requests from REST clients over HTTP.
• ds-cfg-java-class: string
  Default Value: com.oracle.rest.RESTServerExtension

  Specifies the fully-qualified name of the Java class that provides the REST Server Extension implementation.
• ds-cfg-lock-timeout(optional): string
  Default Value: 60000.0ms

  Specifies the length of time to wait while attempting to wait for a response from the LDAP server worker thread.
• ds-cfg-skip-auth-context-path(optional): array ds-cfg-skip-auth-context-path
  Specifies one or more context paths for which the authentication can be skipped.
• ds-cfg-token-validity-period(optional): string
  Default Value: 1d

  Specifies the time interval after the generated JWT bearer token becomes invalid.
• ds-cfg-trust-manager-provider(optional): string
  Default Value: JKS

  Specifies trust manager provider to use for the REST Server Extension to generate or validate OAuth 2.0 Bearer tokens.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "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 REST Server Extension implementation. ",
            "readOnly":false,
            "default":"com.oracle.rest.RESTServerExtension",
            "type":"string"
        },
        "ds-cfg-allow-entry-return":{
            "description":"Enables to return an entry after successful ADD, Modify and ModifyDN operations. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-skip-auth-context-path":{
            "description":"Specifies one or more context paths for which the authentication can be skipped. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-context-path":{
            "description":"Specifies the HTTP context used for all RESTful services ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-trust-manager-provider":{
            "description":"Specifies trust manager provider to use for the REST Server Extension to generate or validate OAuth 2.0 Bearer tokens. ",
            "readOnly":false,
            "default":"JKS",
            "type":"string"
        },
        "ds-cfg-end-point":{
            "description":"The HTTP end points that will be available through REST Server Extension . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-http-authentication-scheme":{
            "description":"The types of authentication scheme that will be used while accepting requests from REST clients over HTTP. ",
            "readOnly":false,
            "default":[
                "basic",
                "bearer"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "anonymous",
                "basic",
                "bearer",
                "client-cert"
            ]
        },
        "ds-cfg-token-validity-period":{
            "description":"Specifies the time interval after the generated JWT bearer token becomes invalid. ",
            "readOnly":false,
            "default":"1d",
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Extension is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-lock-timeout":{
            "description":"Specifies the length of time to wait while attempting to wait for a response from the LDAP server worker thread. ",
            "readOnly":false,
            "default":"60000.0ms",
            "type":"string"
        }
    }
}

Nested Schema : ds-cfg-end-point

Type: array

The HTTP end points that will be available through REST Server Extension .

Show Source

• [0]: string

{
    "description":"The HTTP end points that will be available through REST Server Extension . ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-http-authentication-scheme

Type: array

The types of authentication scheme that will be used while accepting requests from REST clients over HTTP.

Default Value: [ "basic", "bearer" ]

Allowed Values: [ "anonymous", "basic", "bearer", "client-cert" ]

Show Source

• [0]: string

{
    "description":"The types of authentication scheme that will be used while accepting requests from REST clients over HTTP. ",
    "readOnly":false,
    "default":[
        "basic",
        "bearer"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "anonymous",
        "basic",
        "bearer",
        "client-cert"
    ]
}

Nested Schema : ds-cfg-skip-auth-context-path

Type: array

Specifies one or more context paths for which the authentication can be skipped.

Show Source

• [0]: string

{
    "description":"Specifies one or more context paths for which the authentication can be skipped. ",
    "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