Policies

Deactivate subjects for this policy derived from the token

POST

https://ditto.eclipseprojects.io/api/2/policies/{policyId}/actions/deactivateTokenIntegration

This action only works when authenticated with a Json Web Token (JWT).

Based on the authenticated token (JWT), for each policy entry matching those conditions:

the authenticated token is granted the EXECUTE permission to perform the deactivateTokenIntegration action
one of the subject IDs is contained in the authenticated token

the calculated subject with information extracted from the authenticated JWT is removed from the matched policy entry.

The injected subjects expire when the JWT expires. The expiry timestamp (a string in ISO-8601 format) specifies how long the specific subject will have access to the resource secured by the policy. The subject will be automatically deleted from the policy once this timestamp is reached. To give the subject a chance to prolong the access he can configure a connection to get announcements. Policy announcements are published to websockets and connections that have the relevant subject ID.

The settings under announcement control when a policy announcement is published (before expiry or when deleted). If the field requestedAcks is set, then the announcements are published with at-least-once delivery until the acknowledgement requests under labels are fulfilled. If a "beforeExpiry" announcement was sent without acknowledgement requests, or the a "beforeExpiry" announcement was acknowledged, the "whenDeleted" announcement will not be triggered.

Deactivate subjects for this policy derived from the token

curl -X POST 'https://ditto.eclipseprojects.io/api/2/policies/string/actions/deactivateTokenIntegration' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://ditto.eclipseprojects.io/api/2/policies/string/actions/deactivateTokenIntegration', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.post(
    'https://ditto.eclipseprojects.io/api/2/policies/string/actions/deactivateTokenIntegration',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

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

Response

204No Content

The request was successful. Subjects were removed from authorized policy entries.

400Bad Request

The request could not be completed because the authentication was not performed with a JWT.

403Forbidden

The request could not be completed because the authenticated JWT did not have the EXECUTE permission on any entries of the policy.

404Not Found

The request could not be completed because no policy entry matched the following conditions:

containing a a subject ID matching the JWT's authenticated subject

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.

Docs by Sourcey