Modify a Group REST Resource by DN
patch
/rest/v1/admin/{dn}
Modify a Group REST Resource by DN
Request
Supported Media Types
- application/json
Path Parameters
-
dn: string
LDAP DN of the entry to be modified
Group REST Resource that needs to be modified
Root Schema : PatchRequest
Type:
Show Source
object
-
controls(optional):
array controls
LDAP controls to be sent to server for LDAP modify operation.
-
msgType:
string
Default Value:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest
The REST message type -
operations:
array operations
Modifications (Patch operations) to be performed on the entry.
Nested Schema : controls
Type:
array
LDAP controls to be sent to server for LDAP modify operation.
Show Source
Nested Schema : operations
Type:
array
Modifications (Patch operations) to be performed on the entry.
Show Source
Nested Schema : PatchOperation
Type:
Show Source
object
-
attribute:
string
The entry attribute to be modified.
-
opType:
string
Allowed Values:
[ "add", "delete", "replace", "increment" ]
The type of the Patch Operation. -
values(optional):
array values
The attribute values to be updated.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Group REST Resource PatchSuccessResponse
Type:
Show Source
object
-
msgType:
string
Default Value:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse
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.
Nested Schema : searchResultEntries
Type:
array
Number of search result entries returned after the LDAP operation.
Show Source
Nested Schema : Group REST Resource SearchResultEntry
Type:
Show Source
object
-
attributes:
object Group REST Resource Properties
-
dn:
string
LDAP DN of the entry to be created
Nested Schema : Group REST Resource Properties
Type:
Show Source
object
-
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.groups.GroupResource
Specifies the fully-qualified name of the Java class that provides the Group 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:
cn
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=groupOfUniqueNames
TODO -
ds-cfg-resource-end-point:
string
Default Value:
/Groups
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:
Group
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.
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
Nested Schema : ds-cfg-rest-ldap-objectclasses
Type:
array
TODO
Default Value:
Show Source
[
"groupOfUniqueNames"
]
400 Response
ERROR
406 Response
Not Acceptable
Root Schema : ErrorResponse
Type:
Show Source
object
-
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