Policies

Modify the references of a specific policy entry

PUT
https://ditto.eclipseprojects.io/api/2/policies/{policyId}/entries/{label}/references

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

application/json

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) and import (the policy ID of the imported policy)
  • Local reference: contains only entry (the label of another entry in the same policy)
Show child attributes

A single reference to a policy entry.

entrystringrequired

The label of the referenced entry.

importstring

The ID of the imported policy this reference points to. If absent, the reference points to a local entry within the same policy.

Example
[
  {
    "entry": "operator",
    "import": "energy-corp:power-plant-roles"
  },
  {
    "entry": "local-admin"
  }
]

Parameters

policyIdstringrequiredpath

The 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
labelstringrequiredpath

The label of a policy entry

If-Matchstringheader

The If-Match header which has to conform to RFC-7232 (Conditional Requests). Common usages are:

  • optimistic locking by specifying the ETag from 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-Matchstringheader

The 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-mergeheader

The 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.

timeoutstringquery

Defines 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-requiredbooleanquery

Defines 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

201CreatedArray<object>

The references were successfully created (the entry had no references before).

Response headers
ETagstringheader

The (current server-side) ETag for this (sub-)resource. For top-level resources it is in the format "rev:[revision]", for sub-resources it has the format "hash:[calculated-hash]".

Locationstringheader

The location of the created references resource.

Response fields application/json

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) and import (the policy ID of the imported policy)
  • Local reference: contains only entry (the label of another entry in the same policy)
Show child attributes

A single reference to a policy entry.

entrystringrequired

The label of the referenced entry.

importstring

The ID of the imported policy this reference points to. If absent, the reference points to a local entry within the same policy.

Example
[
  {
    "entry": "operator",
    "import": "energy-corp:power-plant-roles"
  },
  {
    "entry": "local-admin"
  }
]
204No Content

The references were successfully updated (the entry already had references).

Response headers
ETagstringheader

The (current server-side) ETag for this (sub-)resource. For top-level resources it is in the format "rev:[revision]", for sub-resources it has the format "hash:[calculated-hash]".

400Bad RequestAdvancedError

The request could not be completed. Possible reasons:

Response fields application/json
statusintegerrequired

The HTTP status of the error

errorstringrequired

The error code of the occurred exception

messagestringrequired

The message of the error - what went wrong

descriptionstring

A description how to fix the error or more details

hrefstring

A link to further information about the error and how to fix it

401UnauthorizedAdvancedError

The request could not be completed due to missing authentication.

Response fields application/json
statusintegerrequired

The HTTP status of the error

errorstringrequired

The error code of the occurred exception

messagestringrequired

The message of the error - what went wrong

descriptionstring

A description how to fix the error or more details

hrefstring

A link to further information about the error and how to fix it

403ForbiddenAdvancedError

The request could not be completed. Possible reasons:

  • the caller has insufficient permissions. You need WRITE permission on the policy:/entries/{label}/references resource, without any revoke in a deeper path of the policy resource.
Response fields application/json
statusintegerrequired

The HTTP status of the error

errorstringrequired

The error code of the occurred exception

messagestringrequired

The message of the error - what went wrong

descriptionstring

A description how to fix the error or more details

hrefstring

A link to further information about the error and how to fix it

404Not FoundAdvancedError

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.

Response fields application/json
statusintegerrequired

The HTTP status of the error

errorstringrequired

The error code of the occurred exception

messagestringrequired

The message of the error - what went wrong

descriptionstring

A description how to fix the error or more details

hrefstring

A link to further information about the error and how to fix it

412Precondition FailedAdvancedError

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.

Response headers
ETagstringheader

The (current server-side) ETag for this (sub-)resource. For top-level resources it is in the format "rev:[revision]", for sub-resources it has the format "hash:[calculated-hash]".

Response fields application/json
statusintegerrequired

The HTTP status of the error

errorstringrequired

The error code of the occurred exception

messagestringrequired

The message of the error - what went wrong

descriptionstring

A description how to fix the error or more details

hrefstring

A link to further information about the error and how to fix it

413Payload Too LargeAdvancedError

The created or modified entity is larger than the accepted limit of 100 kB.

Response fields application/json
statusintegerrequired

The HTTP status of the error

errorstringrequired

The error code of the occurred exception

messagestringrequired

The message of the error - what went wrong

descriptionstring

A description how to fix the error or more details

hrefstring

A link to further information about the error and how to fix it

Authorization

OpenIDConnectopenIdConnect

OpenID 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.