Modify the references of a specific policy entry
Sets the references of the policy entry identified by the
policyId path parameter and the label path parameter.
References define links to other policy entries, optionally from imported policies.
Each reference object contains a required entry field (the label of the referenced entry)
and an optional import field (the policy ID of the import to reference from).
Setting an empty array removes all references from this entry.
Body
JSON array of reference objects. Each object must contain a required entry field
(the label of the referenced policy entry) and may contain an optional import field
(the policy ID of the import to reference from).
An optional list of references to other policy entries. Each reference points to an entry either in the same policy (local reference) or in an imported policy (import reference). When set, subjects, resources, and namespaces from the referenced entries are additively merged into this entry.
- Import reference: contains both
entry(the label) andimport(the policy ID of the imported policy) - Local reference: contains only
entry(the label of another entry in the same policy)
[
{
"entry": "operator",
"import": "energy-corp:power-plant-roles"
},
{
"entry": "local-admin"
}
]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
labelstringrequiredpathThe label of a policy entry
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 HTTP response, e.g.If-Match: "hash:a75ece4e" - 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: *.
if-equalstringupdateskipskip-minimizing-mergeheaderThe if-equal header can take the values 'update' (which is the default if omitted), 'skip' or 'skip-minimizing-merge'. If 'update' is defined, the entity will always be updated, even if it is equal before the update. If 'skip' is defined, the entity not be updated if it is equal before the update. In this case a 'Precondition Failed' 412 status is returned. If 'skip-minimizing-merge' is defined, the entity will not be updated if it is equal before the update. In this case a 'Precondition Failed' 412 status is returned. Additionally, merge/patch commands will be minimized to only the fields which actually changed, compared to the current state of the entity.
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 references were successfully created (the entry had no references before).
The references were successfully updated (the entry already had references).
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 JSON body of the references is invalid
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 thepolicy:/entries/{label}/referencesresource, without any revoke in a deeper path of the policy resource.
The request could not be completed. The policy with the given ID or the policy entry 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.
The created or modified entity is larger than the accepted limit of 100 kB.
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.