Delete a configuration element and all its references
delete
https://{managementIp}/rest/{version}/configuration/configReferences
Deletes the specified configuration element and all its references in the system configuration. The client making the DELETE request must already possess the configuration lock or the request fails. Currently, this operation can be performed only on realm-config. For configuration element types that are singletons, which have no key attributes, this operation is not supported. For element types that can have multiple instances, the query string must include "&name=value" for each key attribute, where name is a key attribute name and value is the associated value. The order of the key attributes in the query string does not matter. The key attributes for an element type are identified in the metadata (/configuration/elementTypes/metadata). This operation deletes a single configuration element instance and its references at a time.
Request
Path Parameters
-
version(required): string
REST API version string.
Available values: v1.2Allowed Values:[ "v1.2" ]
Query Parameters
-
elementType(required): string
Indicates the configuration element type being deleted. Currently, realm-config only supported.
-
name=value(required): string
Specifies the name and value for one key attribute of the elementType. For elementTypes having multiple key attributes, each one must be represented by "&name=value" in the query string.
Header Parameters
-
Authorization(required):
The value in the Authorization header must be the string "
Bearer {access token}
", where{access token}
is a valid, unexpired token received in response to a prior/rest/{version}/auth/token
request.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
204 Response
Successful deletion of the configuration element and all its references. There is no response body for a successful delete.
400 Response
The request is malformed in some way or is missing required information and therefore cannot be processed.
Nested Schema : data
Type:
object
Nested Schema : items
Type:
Show Source
object
-
link: string
If available, a message with possible valid API URL(s) for the client to invokeExample:
Available URL(s) message string
401 Response
Unauthorized - Request lacks valid authentication credentials.
Nested Schema : data
Type:
object
Nested Schema : items
Type:
Show Source
object
-
link: string
If available, a message with possible valid API URL(s) for the client to invokeExample:
Available URL(s) message string
403 Response
This request requires the client credentials to have administrator privileges.
Nested Schema : data
Type:
object
Nested Schema : items
Type:
Show Source
object
-
link: string
If available, a message with possible valid API URL(s) for the client to invokeExample:
Available URL(s) message string
404 Response
Unsupported versionId in URI, or requested element type not supported, or element instance specified by key attribute(s) not found.
Nested Schema : data
Type:
object
Nested Schema : items
Type:
Show Source
object
-
link: string
If available, a message with possible valid API URL(s) for the client to invokeExample:
Available URL(s) message string
423 Response
The request requires the configuration lock and failed because the client does not currently own the lock. If another client or user currently owns the configuration lock, the error message is "Resource locked by another user". If no client or user owns the configuration lock, the error message is "User does not have the lock".
Nested Schema : data
Type:
object
Nested Schema : items
Type:
Show Source
object
-
link: string
If available, a message with possible valid API URL(s) for the client to invokeExample:
Available URL(s) message string