Add, Search, Compare or Delete User REST Resource
post
/rest/v1/admin
Add, Search, Compare or Delete User REST Resource
Request
Supported Media Types
- application/json
User REST Resource that needs to be created
Root Schema : User REST Resource POSTRequest
Type:
Show Source
object-
assertion:
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:
object User REST Resource Properties
-
base:
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:
array controls
LDAP controls to be sent to server for the LDAP operation.
-
dn:
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:
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(required):
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:
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:
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.
Nested Schema : User REST Resource Properties
Type:
Show Source
object-
cn:
string
CN (common name) of the entry
-
ds-cfg-core-schema-urn(required):
string
The core resource's schema which.
-
ds-cfg-enabled(required):
boolean
Indicates whether the REST Resource is enabled.
-
ds-cfg-java-class(required):
string
Default Value:
com.oracle.scim.resources.users.UserResourceSpecifies the fully-qualified name of the Java class that provides the User REST Resource implementation. -
ds-cfg-resource-add-template-basedn(required):
string
Specifies the base-dn where the resource type will be added.
-
ds-cfg-resource-add-template-rdn-attr-type(required):
string
Default Value:
uidSpecifies the rdn attribute type that will be used while adding a resource type. -
ds-cfg-resource-attr-map:
array ds-cfg-resource-attr-map
TODO
-
ds-cfg-resource-containers:
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:
string
Default Value:
objectclass=inetorgpersonTODO -
ds-cfg-resource-end-point(required):
string
Default Value:
/UsersSpecifies the REST resource end point URL. -
ds-cfg-resource-id-attr:
string
Default Value:
entryUUIDSpecifies the id attribute of the resource. -
ds-cfg-resource-name(required):
string
Default Value:
UserSpecifies the REST resource name. -
ds-cfg-rest-ldap-objectclasses:
array ds-cfg-rest-ldap-objectclasses
TODO
-
objectclass(required):
array objectclass
Objectclass(es) which this entry belongs to.
Nested Schema : controls
Type:
arrayLDAP controls to be sent to server for the LDAP operation.
Show Source
Nested Schema : requiredAttributes
Type:
arrayList 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
Nested Schema : ds-cfg-resource-containers
Type:
arraySpecifies one or more alternate DNs that can be used to bind to the server as this root user.
Show Source
Nested Schema : ds-cfg-rest-ldap-objectclasses
Type:
arrayTODO
Default Value:
Show Source
[
"inetorgperson"
]Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : User REST Resource SuccessResponse
Type:
Show Source
object-
compareResult:
boolean
Indicates the result of LDAP compare operation.
-
msgType(required):
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(required):
array searchResultEntries
Number of search result entries returned after the LDAP operation.
-
totalResults(required):
integer(int32)
Specifies the number of entries created, and returned.
Nested Schema : searchResultEntries
Type:
arrayNumber of search result entries returned after the LDAP operation.
Show Source
Nested Schema : User REST Resource SearchResultEntry
Type:
Show Source
object-
attributes(required):
object User REST Resource Properties
-
dn(required):
string
LDAP DN of the entry to be created
Nested Schema : User REST Resource Properties
Type:
Show Source
object-
cn:
string
CN (common name) of the entry
-
ds-cfg-core-schema-urn(required):
string
The core resource's schema which.
-
ds-cfg-enabled(required):
boolean
Indicates whether the REST Resource is enabled.
-
ds-cfg-java-class(required):
string
Default Value:
com.oracle.scim.resources.users.UserResourceSpecifies the fully-qualified name of the Java class that provides the User REST Resource implementation. -
ds-cfg-resource-add-template-basedn(required):
string
Specifies the base-dn where the resource type will be added.
-
ds-cfg-resource-add-template-rdn-attr-type(required):
string
Default Value:
uidSpecifies the rdn attribute type that will be used while adding a resource type. -
ds-cfg-resource-attr-map:
array ds-cfg-resource-attr-map
TODO
-
ds-cfg-resource-containers:
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:
string
Default Value:
objectclass=inetorgpersonTODO -
ds-cfg-resource-end-point(required):
string
Default Value:
/UsersSpecifies the REST resource end point URL. -
ds-cfg-resource-id-attr:
string
Default Value:
entryUUIDSpecifies the id attribute of the resource. -
ds-cfg-resource-name(required):
string
Default Value:
UserSpecifies the REST resource name. -
ds-cfg-rest-ldap-objectclasses:
array ds-cfg-rest-ldap-objectclasses
TODO
-
objectclass(required):
array objectclass
Objectclass(es) which this entry belongs to.
Nested Schema : ds-cfg-resource-containers
Type:
arraySpecifies one or more alternate DNs that can be used to bind to the server as this root user.
Show Source
Nested Schema : ds-cfg-rest-ldap-objectclasses
Type:
arrayTODO
Default Value:
Show Source
[
"inetorgperson"
]201 Response
Created
Root Schema : User REST Resource ADDResponse
Type:
Show Source
object-
msgType(required):
string
Default Value:
urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponseThe REST message type -
searchResultEntries(required):
array searchResultEntries
-
totalResults(required):
integer(int32)
Specifies the number of entries created, and returned.
Nested Schema : User REST Resource SearchResultEntry
Type:
Show Source
object-
attributes(required):
object User REST Resource Properties
-
dn(required):
string
LDAP DN of the entry to be created
Nested Schema : User REST Resource Properties
Type:
Show Source
object-
cn:
string
CN (common name) of the entry
-
ds-cfg-core-schema-urn(required):
string
The core resource's schema which.
-
ds-cfg-enabled(required):
boolean
Indicates whether the REST Resource is enabled.
-
ds-cfg-java-class(required):
string
Default Value:
com.oracle.scim.resources.users.UserResourceSpecifies the fully-qualified name of the Java class that provides the User REST Resource implementation. -
ds-cfg-resource-add-template-basedn(required):
string
Specifies the base-dn where the resource type will be added.
-
ds-cfg-resource-add-template-rdn-attr-type(required):
string
Default Value:
uidSpecifies the rdn attribute type that will be used while adding a resource type. -
ds-cfg-resource-attr-map:
array ds-cfg-resource-attr-map
TODO
-
ds-cfg-resource-containers:
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:
string
Default Value:
objectclass=inetorgpersonTODO -
ds-cfg-resource-end-point(required):
string
Default Value:
/UsersSpecifies the REST resource end point URL. -
ds-cfg-resource-id-attr:
string
Default Value:
entryUUIDSpecifies the id attribute of the resource. -
ds-cfg-resource-name(required):
string
Default Value:
UserSpecifies the REST resource name. -
ds-cfg-rest-ldap-objectclasses:
array ds-cfg-rest-ldap-objectclasses
TODO
-
objectclass(required):
array objectclass
Objectclass(es) which this entry belongs to.
Nested Schema : ds-cfg-resource-containers
Type:
arraySpecifies one or more alternate DNs that can be used to bind to the server as this root user.
Show Source
Nested Schema : ds-cfg-rest-ldap-objectclasses
Type:
arrayTODO
Default Value:
Show Source
[
"inetorgperson"
]204 Response
No content
406 Response
Not Acceptable
Root Schema : ErrorResponse
Type:
Show Source
object-
ldapErrorCode:
integer(int32)
Specifies the LDAP error code returned for the operation.
-
message(required):
string
Error message returned returned for the operation.
-
msgType(required):
string
Default Value:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponseThe REST message type