Modify a Saml Xasp Workflow Element by DN
patch
/rest/v1/admin/{dn}
Modify a Saml Xasp Workflow Element by DN
Request
Supported Media Types
- application/json
Path Parameters
-
dn: string
LDAP DN of the entry to be modified
Saml Xasp Workflow Element 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 : Saml Xasp Workflow Element 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 : Saml Xasp Workflow Element SearchResultEntry
Type:
Show Source
object
-
attributes:
object Saml Xasp Workflow Element Properties
-
dn:
string
LDAP DN of the entry to be created
Nested Schema : Saml Xasp Workflow Element Properties
Type:
Show Source
object
-
cn(optional):
string
CN (common name) of the entry
-
ds-cfg-enabled:
boolean
Indicates whether the Workflow Element is enabled for use in the server.
-
ds-cfg-java-class:
string
Default Value:
org.opends.server.workflowelement.ovdplugin.xasp.SamlXaspWorkflowElement
Specifies the fully-qualified name of the Java class that provides the Saml Xasp Workflow Element implementation. -
ds-cfg-xasp-attribute-name:
string
Defines the attribute that contains the DN of the entry in the search filter, for example certificatedn.
-
ds-cfg-xasp-base-dn:
string
Base dn to be used in case value not present in filter.
-
ds-cfg-xasp-contains-dn:
string
Defines a string that must be part of the DN of the entry, for example dc=example.
-
ds-cfg-xasp-debug(optional):
boolean
Default Value:
false
Specifies whether to log additional messages. -
ds-cfg-xasp-index(optional):
string
Defines a comma-separated list of attributes that is used to index the results, for example cn.
-
ds-cfg-xasp-response(optional):
string
Defines a comma-separated list of attribute=value pairs that is added to each returned entry, for example department=Sales.
-
ds-cfg-xasp-reverse-dn(optional):
boolean
Default Value:
false
Defines whether the DN contained in the certificate is reversed, for example dc=com,dc=example,cn=users,cn=user1. -
ds-cfg-xasp-ttl(optional):
string
Defines the Cache Time-To-Live in milliseconds.
-
ds-cfg-xasp-ws-url:
string
Defines the web service URL of the identity provider.
-
objectclass:
array objectclass
Objectclass(es) which this entry belongs to.
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