Update rule

PUT 
/api/management/policy/rule/:id

Update rule template

Request

Path Parameters

id numberrequired

application/json

Bodyrequired

idnumber
actionstring[]required
Example: ["READ","USE"]
assigneestring[]
Example: ["did:example:assignee"]
constraints object[]required
Array [
idnumber
typeConstraintType (string)required
Possible values: [ATOMIC, LOGICAL]
Example: ATOMIC
titlestringrequired
Example: Constraint title
descriptionstring
Example: Constraint description
]
dutiesundefined[]required
typeRuleType (string)
Possible values: [PERMISSION, PROHIBITION, DUTY]
targetstring

Responses

200

application/json

Schema

Schema

idnumber
actionstring[]required
Example: ["READ","USE"]
assigneestring[]
Example: ["did:example:assignee"]
constraints object[]required
Array [
idnumber
typeConstraintType (string)required
Possible values: [ATOMIC, LOGICAL]
Example: ATOMIC
titlestringrequired
Example: Constraint title
descriptionstring
Example: Constraint description
]
dutiesundefined[]required
typeRuleType (string)
Possible values: [PERMISSION, PROHIBITION, DUTY]
targetstring

Example (auto)

{
  "id": 0,
  "action": [
    "READ",
    "USE"
  ],
  "assignee": [
    "did:example:assignee"
  ],
  "constraints": [
    {
      "id": 0,
      "type": "ATOMIC",
      "title": "Constraint title",
      "description": "Constraint description"
    }
  ],
  "duties": [
    null
  ],
  "type": "PERMISSION",
  "target": "string"
}

400

Malformed request

application/json

Schema

Schema

namestringrequired
Example: ResourceNotFound
statusstringrequired
Example: 404 Not Found
codenumberrequired
Example: 404
messageobject
Example: The requested resource does not exist.
errorstring
Example: Not Found

Example (auto)

{
  "name": "ResourceNotFound",
  "status": "404 Not Found",
  "code": 404,
  "message": "The requested resource does not exist.",
  "error": "Not Found"
}

403

Forbidden

application/json

Schema

Schema

namestringrequired
Example: ResourceNotFound
statusstringrequired
Example: 404 Not Found
codenumberrequired
Example: 404
messageobject
Example: The requested resource does not exist.
errorstring
Example: Not Found

Example (auto)

{
  "name": "ResourceNotFound",
  "status": "404 Not Found",
  "code": 404,
  "message": "The requested resource does not exist.",
  "error": "Not Found"
}

404

Resource not found

application/json

Schema

Schema

namestringrequired
Example: ResourceNotFound
statusstringrequired
Example: 404 Not Found
codenumberrequired
Example: 404
messageobject
Example: The requested resource does not exist.
errorstring
Example: Not Found

Example (auto)

{
  "name": "ResourceNotFound",
  "status": "404 Not Found",
  "code": 404,
  "message": "The requested resource does not exist.",
  "error": "Not Found"
}

409

Resource already exists

application/json

Schema

Schema

namestringrequired
Example: ResourceNotFound
statusstringrequired
Example: 404 Not Found
codenumberrequired
Example: 404
messageobject
Example: The requested resource does not exist.
errorstring
Example: Not Found

Example (auto)

{
  "name": "ResourceNotFound",
  "status": "404 Not Found",
  "code": 404,
  "message": "The requested resource does not exist.",
  "error": "Not Found"
}

Authorization: oauth2

name: oauth2type: oauth2scopes: controlplane_adminflows: {
  "password": {
    "scopes": {
      "controlplane_admin": "controlplane_admin",
      "controlplane_dataplane": "controlplane_dataplane"
    }
  }
}

• curl
• http

• CURL

curl -L -X PUT 'https://tsg.dataspac.es/api/management/policy/rule/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
  "id": 0,
  "action": [
    "READ",
    "USE"
  ],
  "assignee": [
    "did:example:assignee"
  ],
  "constraints": [
    {
      "id": 0,
      "type": "ATOMIC",
      "title": "Constraint title",
      "description": "Constraint description"
    }
  ],
  "duties": [
    null
  ],
  "type": "PERMISSION",
  "target": "string"
}'

Request Collapse all

Auth

Bearer Token

Parameters

id — pathrequired

Body required

{
  "id": 0,
  "action": [
    "READ",
    "USE"
  ],
  "assignee": [
    "did:example:assignee"
  ],
  "constraints": [
    {
      "id": 0,
      "type": "ATOMIC",
      "title": "Constraint title",
      "description": "Constraint description"
    }
  ],
  "duties": [
    null
  ],
  "type": "PERMISSION",
  "target": "string"
}