Skip to content

Commit 2b9bd5f

Browse files
add revoked/deleted doc (#43)
1 parent 87a0f6b commit 2b9bd5f

2 files changed

Lines changed: 18 additions & 2 deletions

File tree

mkdocs/docs/resource-management/0.1/permissions-list.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ This message is commonly used as a response to [/resource-management/0.1/permiss
1111
"id": "<resource_id>",
1212
"granted": [{"did": "<did>", "timestamp": <unix_timestamp>}],
1313
"pending": [{"did": "<did>", "timestamp": <unix_timestamp>}],
14-
"rejected": [{"did": "<did>", "timestamp": <unix_timestamp>}]
14+
"rejected": [{"did": "<did>", "timestamp": <unix_timestamp>}],
15+
"revoked": [{"did": "<did>", "timestamp": <unix_timestamp>}],
16+
"deleted": [{"did": "<did>", "timestamp": <unix_timestamp>}]
1517
}
1618
```
1719

@@ -22,6 +24,8 @@ This message is commonly used as a response to [/resource-management/0.1/permiss
2224
| **granted** | List of objects representing users who have been granted access to the resource. Each entry includes the user’s DID and the timestamp when access was granted. | object[] ||
2325
| **pending** | List of objects representing users whose permission requests are awaiting approval. Each entry includes the user’s DID and the timestamp when the request was received. | object[] ||
2426
| **rejected** | List of objects representing users whose permission requests were explicitly rejected. Each entry includes the user’s DID and the timestamp when the rejection occurred. | object[] ||
27+
| **revoked** | List of objects representing users whose permission requests were explicitly revoked. Each entry includes the user’s DID and the timestamp when the rejection occurred. | object[] ||
28+
| **deleted** | List of objects representing users whose permission requests were explicitly deleted. Each entry includes the user’s DID and the timestamp when the rejection occurred. | object[] ||
2529

2630

2731
| Field | Description | Type | Required |
@@ -59,6 +63,12 @@ This message is commonly used as a response to [/resource-management/0.1/permiss
5963
"did": "did:iden3:polygon:amoy:john",
6064
"timestamp": 1738859900
6165
}
66+
],
67+
"deleted": [
68+
{
69+
"did": "did:iden3:polygon:amoy:alice",
70+
"timestamp": 1738859900
71+
}
6272
]
6373
}
6474
}

mkdocs/docs/resource-management/0.1/permissions-update.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ Attachments may also be included to share encrypted authorization data or other
99
{
1010
"id": "<resource_id>",
1111
"grant": ["<list_of_dids_with_granted_access>"],
12-
"reject": ["<list_of_dids_with_rejected_access>"]
12+
"reject": ["<list_of_dids_with_rejected_access>"],
13+
"revoke": ["<list_of_dids_with_revoked_access>"]
1314
}
1415
```
1516

@@ -18,6 +19,8 @@ Attachments may also be included to share encrypted authorization data or other
1819
| **id** | Unique identifier of the resource for which permissions are being updated. In the current implementation, this corresponds to the configuration ID. | string ||
1920
| **grant** | List of DIDs that have been granted access to the resource. | string[] ||
2021
| **reject** | List of DIDs that were explicitly denied access. This field can be omitted if no rejections are needed. | string[] ||
22+
| **revoke** | List of DIDs whose access was revoked. This field can be omitted if no revocations are needed. | string[] ||
23+
2124

2225

2326
- **Example of permissions-update:**
@@ -38,6 +41,9 @@ Attachments may also be included to share encrypted authorization data or other
3841
],
3942
"reject": [
4043
"did:iden3:polygon:amoy:alex"
44+
],
45+
"revoke": [
46+
"did:iden3:polygon:amoy:alice"
4147
]
4248
},
4349
"attachments": [

0 commit comments

Comments
 (0)