Skip to content

Commit 0245f24

Browse files
authored
Confluence source connector: now outputs permissions metadata (#590)
1 parent a37369b commit 0245f24

File tree

1 file changed

+67
-1
lines changed

1 file changed

+67
-1
lines changed

snippets/general-shared-text/confluence.mdx

Lines changed: 67 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,70 @@ title="YouTube video player"
3030
frameborder="0"
3131
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
3232
allowfullscreen
33-
></iframe>
33+
></iframe>
34+
35+
## Document permissions metadata
36+
37+
The source connector outputs any permissions information that it can find in the source location about the processed source documents and associates that information with each
38+
corresponding element that is generated. This permissions information is output into the `permissions_data` field, which is within the
39+
`data_source` field under the element's `metadata` field. This information lists the users or groups, if any, that have
40+
permissions to read, update, or delete the element's associated source document.
41+
42+
The following example shows what the output looks like. Ellipses indicate content that has been omitted from this example for brevity.
43+
44+
```json
45+
[
46+
{
47+
"...": "...",
48+
"metadata": {
49+
"...": "...",
50+
"data_source": {
51+
"...": "...",
52+
"permissions_data": [
53+
{
54+
"read": {
55+
"users": [
56+
"11111:11111111-1111-1111-1111-111111111111"
57+
],
58+
"groups": [
59+
"22222222-2222-2222-2222-22222222",
60+
"33333333-3333-3333-3333-33333333"
61+
]
62+
}
63+
},
64+
{
65+
"update": {
66+
"users": [
67+
"44444:44444444-4444-4444-4444-44444444",
68+
"55555:55555555-5555-5555-5555-55555555"
69+
],
70+
"groups": [
71+
"66666666-6666-6666-6666-66666666",
72+
]
73+
}
74+
},
75+
{
76+
"delete": {
77+
"users": [
78+
"77777:77777777-7777-7777-7777-77777777"
79+
],
80+
"groups": [
81+
"88888888-8888-8888-8888-88888888"
82+
]
83+
}
84+
}
85+
],
86+
"...": "..."
87+
}
88+
}
89+
}
90+
]
91+
```
92+
93+
To look up information about a particular Confluence user, use the user's ID (also known as their _account ID_) from the preceding output to call the
94+
[GET /wiki/rest/api/user](https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-users/#api-wiki-rest-api-user-get)
95+
operation in the Confluence REST API.
96+
97+
To look up information about a particular Confluence group, use the group's ID from the preceding output to call the
98+
[GET /wiki/rest/api/group/by-id](https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group/#api-wiki-rest-api-group-by-id-get)
99+
operation in the Confluence REST API.

0 commit comments

Comments
 (0)