Policies

Check permissions for specified entities

POST

https://ditto.eclipseprojects.io/api/2/checkPermissions

This endpoint allows you to verify permissions for various entities on specific resources.

curl -X POST 'https://ditto.eclipseprojects.io/api/2/checkPermissions' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

const response = await fetch('https://ditto.eclipseprojects.io/api/2/checkPermissions', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body: '{}',
});

const data = await response.text();

import requests

response = requests.post(
    'https://ditto.eclipseprojects.io/api/2/checkPermissions',
    data='{}'.encode('utf-8'),
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{}

{}

{
  "status": 0,
  "error": "string",
  "message": "string",
  "description": "string",
  "href": "string"
}

Body

application/json

JSON object containing permission check requests, keyed by an arbitrary identifier.

Request to check permissions for various entities and resources.

[key: string]object

Details for a specific permission check request.

Show child attributes

resourcestring

Resource path the permission check applies to.

entityIdstring

thingId of the entity performing the action.

hasPermissionsArray<string>READWRITE

Required permissions on the resource.

Response

200OKobject

Response with permission check results for each entity.

Response fields application/json

Response with permission check results for each entity.

[key: string]boolean

401UnauthorizedAdvancedError

Unauthorized request 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

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