REST API for Oracle Unified Directory Administration

Find User REST Resource by DN

get

/rest/v1/admin/{dn}

Returns an User REST Resource 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" ]

Response

Supported Media Types

application/json

200 Response

Root Schema : User REST Resource 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/User REST Resource SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object User REST Resource SearchResultEntry

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

Nested Schema : User REST Resource SearchResultEntry

Type: object

Show Source

attributes: object User REST Resource 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/User REST Resource Properties"
        }
    }
}

Nested Schema : User REST Resource Properties

Type: object

Show Source

cn(optional): string

CN (common name) of the entry
ds-cfg-core-schema-urn: string

The core resource's schema which.
ds-cfg-enabled: boolean

Indicates whether the REST Resource is enabled.
ds-cfg-java-class: string

Default Value: com.oracle.scim.resources.users.UserResource

Specifies the fully-qualified name of the Java class that provides the User REST Resource implementation.
ds-cfg-resource-add-template-basedn: string

Specifies the base-dn where the resource type will be added.
ds-cfg-resource-add-template-rdn-attr-type: string

Default Value: uid

Specifies the rdn attribute type that will be used while adding a resource type.
ds-cfg-resource-attr-map(optional): array ds-cfg-resource-attr-map

TODO
ds-cfg-resource-containers(optional): array ds-cfg-resource-containers

Specifies one or more alternate DNs that can be used to bind to the server as this root user.
ds-cfg-resource-def-filter(optional): string

Default Value: objectclass=inetorgperson

TODO
ds-cfg-resource-end-point: string

Default Value: /Users

Specifies the REST resource end point URL.
ds-cfg-resource-id-attr(optional): string

Default Value: entryUUID

Specifies the id attribute of the resource.
ds-cfg-resource-name: string

Default Value: User

Specifies the REST resource name.
ds-cfg-rest-ldap-objectclasses(optional): array ds-cfg-rest-ldap-objectclasses

TODO
objectclass: array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-resource-add-template-basedn",
        "ds-cfg-resource-end-point",
        "ds-cfg-resource-name",
        "ds-cfg-core-schema-urn",
        "ds-cfg-enabled",
        "ds-cfg-resource-add-template-rdn-attr-type"
    ],
    "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 User REST Resource implementation. ",
            "readOnly":false,
            "default":"com.oracle.scim.resources.users.UserResource",
            "type":"string"
        },
        "ds-cfg-resource-add-template-basedn":{
            "description":"Specifies the base-dn where the resource type will be added. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-rest-ldap-objectclasses":{
            "description":"TODO ",
            "readOnly":false,
            "default":[
                "inetorgperson"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-resource-id-attr":{
            "description":"Specifies the id attribute of the resource. ",
            "readOnly":false,
            "default":"entryUUID",
            "type":"string"
        },
        "ds-cfg-resource-containers":{
            "description":"Specifies one or more alternate DNs that can be used to bind to the server as this root user. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-resource-end-point":{
            "description":"Specifies the REST resource end point URL. ",
            "readOnly":false,
            "default":"/Users",
            "type":"string"
        },
        "ds-cfg-resource-def-filter":{
            "description":"TODO ",
            "readOnly":false,
            "default":"objectclass=inetorgperson",
            "type":"string"
        },
        "ds-cfg-resource-name":{
            "description":"Specifies the REST resource name. ",
            "readOnly":false,
            "default":"User",
            "type":"string"
        },
        "ds-cfg-core-schema-urn":{
            "description":"The core resource's schema which. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the REST Resource is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-resource-add-template-rdn-attr-type":{
            "description":"Specifies the rdn attribute type that will be used while adding a resource type. ",
            "readOnly":false,
            "default":"uid",
            "type":"string"
        },
        "ds-cfg-resource-attr-map":{
            "description":"TODO ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ds-cfg-resource-attr-map

Type: array

TODO

Show Source

Array of: string

{
    "description":"TODO ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-resource-containers

Type: array

Specifies one or more alternate DNs that can be used to bind to the server as this root user.

Show Source

Array of: string

{
    "description":"Specifies one or more alternate DNs that can be used to bind to the server as this root user. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-rest-ldap-objectclasses

Type: array

TODO

Default Value:

[
    "inetorgperson"
]

Show Source

Array of: string

{
    "description":"TODO ",
    "readOnly":false,
    "default":[
        "inetorgperson"
    ],
    "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"
    }
}

406 Response

Not Acceptable

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."
        }
    }
}