Delete a specific policy
Deletes the policy identified by the policyId path parameter. Deleting
a policy does not implicitly delete other entities (e.g. things) which
use this policy.
Note: Delete the respective things before deleting the
policy, otherwise nobody has permission to read, update, or delete the things.
If you accidentally run into such a scenario, re-create the policy via
PUT /policies/{policyId}.
Parameters
policyIdstringrequiredpathThe ID of the policy needs to follow the namespaced entity ID notation (see Ditto documentation on namespaced entity IDs).
The namespace needs to:
- conform to the reverse domain name notation
If-MatchstringheaderThe If-Match header, which has to conform to RFC-7232 (Conditional Requests). Common usages are:
- optimistic locking by specifying the
ETagfrom a previous GET response, e.g.If-Match: "rev:4711" - retrieving or modifying a resource only if it already exists, e.g.
If-Match: *
If-None-MatchstringheaderThe If-None-Match header, which has to conform to RFC-7232 (Conditional Requests). A common usage scenario is to modify a resource only if it does not yet exist, thus to create it, by specifying If-None-Match: *.
timeoutstringqueryDefines how long the backend should wait for completion of the request, e.g. applied when waiting for requested
acknowledgements via the requested-acks param. Can be specified without unit (then seconds are assumed) or
together with s, ms or m unit. Example: 42s, 1m.
The default (if omitted) and maximum timeout is 60s. A value of 0 applies fire and forget semantics for
the command resulting in setting response-required=false.
response-requiredbooleanqueryDefines whether a response is required to the API call or not - if set to false the response will directly
sent back with a status code of 202 (Accepted).
The default (if ommited) response is true.
Response
The policy was successfully deleted.
The request could not be completed. Possible reasons:
- the
policyIddoes not conform to the namespaced entity ID notation (see Ditto documentation on namespaced entity IDs)
The request could not be completed due to missing authentication.
The request could not be completed. Possible reasons:
- the caller has insufficient permissions.
You need
WRITEpermission on the rootpolicy:/resource, without any revoke in a deeper path of the policy resource.having any revoke.
The request could not be completed. The policy with the given ID or policy referenced in a policy import was not found in the context of the authenticated user.
A precondition for reading or writing the (sub-)resource failed. This will happen for write requests, if you specified an If-Match or If-None-Match header, which fails the precondition check against the current ETag of the (sub-)resource. For read requests, this error may only happen for a failing If-Match header. In case of a failing If-None-Match header for a read request, status 304 will be returned instead.
Authorization
OpenIDConnectopenIdConnectOpenID Connect Discovery URL. The placeholder is replaced by Swagger UI when configured.
NginxBasichttp (basic)Eclipse Ditto sandbox demo user (demo1 ... demo9) + password (demo)
Bearerhttp (bearer)A JSON Web Token issued by a supported OAuth 2.0 Identity Provider.