Returns user details for the ids provided in the request body.
Permissions required: Permission to access the Confluence site ('Can use' global permission). The user must be able to view user profiles in the Confluence site.
read:user:confluenceConnect app scope required: READ
array<string>
RequiredReturned if the user info is returned for the account IDs. results may be empty if no account IDs were found.
string
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"accountIds": [
"<string>"
]
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/users-bulk`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"results": [
{
"displayName": "<string>",
"timeZone": "<string>",
"personalSpaceId": "<string>",
"isExternalCollaborator": true,
"accountStatus": "active",
"accountId": "<string>",
"email": "<string>",
"accountType": "atlassian",
"publicName": "<string>",
"profilePicture": {
"path": "<string>",
"isDefault": true
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns the list of emails from the input list that do not have access to site.
Permissions required: Permission to access the Confluence site ('Can use' global permission).
read:configuration:confluenceConnect app scope required: NONE
array<string>
RequiredReturns object with list of emails without access to site.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"emails": [
"<string>"
]
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/user/access/check-access-by-email`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
{
"emailsWithoutAccess": [
"<string>"
],
"invalidEmails": [
"<string>"
]
}Invite a list of emails to the site.
Ignores all invalid emails and no action is taken for the emails that already have access to the site.
NOTE: This API is asynchronous and may take some time to complete.
Permissions required: Permission to access the Confluence site ('Can use' global permission).
read:configuration:confluenceConnect app scope required: NONE
array<string>
RequiredReturns object with list of emails without access to site.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"emails": [
"<string>"
]
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/user/access/invite-by-email`, {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Rate this page: