Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "accountId" "<string>"
CkJsonObject_UpdateString $queryParams "expand" "<string>"
CkJsonObject_UpdateString $queryParams "expand" "<string>"
CkJsonObject_UpdateString $queryParams "limit" "<integer>"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://your-domain.atlassian.net/wiki/rest/api/user/bulk" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "results": [
# {
# "type": "user",
# "accountId": "elit est ullamco in officia",
# "accountType": "exercitation fugiat labo",
# "email": "Excepteur in cillum officia",
# "publicName": "ullamco occaecat",
# "profilePicture": {
# "path": "cupidatat dolore et labore ad",
# "width": -99848841,
# "height": 55035562,
# "isDefault": true
# },
# "displayName": "amet",
# "_expandable": {
# "operations": "labore ut Duis id culpa",
# "details": "in irure voluptate Duis magna",
# "personalSpace": "n"
# },
# "_links": {},
# "username": "est sunt dolor nostrud",
# "userKey": "labo",
# "operations": [
# {
# "operation": "update",
# "targetType": "attachment"
# },
# {
# "operation": "administer",
# "targetType": "attachment"
# }
# ],
# "details": {
# "business": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "personal": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "personalSpace": {
# "id": -93610124,
# "key": "in eiusmod",
# "name": "ut minim Excepteur",
# "type": "sunt qui amet",
# "status": "null",
# "_expandable": {
# "settings": "pariatur deserunt anim",
# "metadata": "anim occaecat aliqua",
# "operations": "aute nostrud in",
# "lookAndFeel": "est irure aute labore",
# "permissions": "in cupidatat qui",
# "icon": "voluptate Duis",
# "description": "culpa veniam Lorem velit",
# "theme": "consequat sunt reprehenderit",
# "history": "ex officia veniam sit do",
# "homepage": "dolore dolore"
# },
# "_links": {},
# "icon": {
# "path": "dolore Lorem magna sunt",
# "width": 3933679,
# "height": -17426468,
# "isDefault": false
# },
# "description": {
# "plain": {
# "value": "consequat consectetur laborum labore occaecat",
# "representation": "view",
# "embeddedContent": [
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# ]
# },
# "view": {
# "value": "Duis reprehenderit anim ut",
# "representation": "view",
# "embeddedContent": [
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# ]
# }
# },
# "homepage": {
# "value": "<Circular reference to #/components/schemas/Content detected>"
# },
# "metadata": {
# "labels": {
# "results": [
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# ],
# "start": 23981894,
# "limit": -68365223,
# "size": -97521792,
# "_links": {}
# }
# },
# "operations": [
# {
# "operation": "administer",
# "targetType": "blogpost"
# },
# {
# "operation": "delete",
# "targetType": "blogpost"
# }
# ],
# "permissions": [
# {
# "subjects": {
# "_expandable": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "user": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "group": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "operation": {
# "operation": "read",
# "targetType": "space"
# },
# "anonymousAccess": false,
# "unlicensedAccess": false
# },
# {
# "subjects": {
# "_expandable": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "user": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "group": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "operation": {
# "operation": "restore",
# "targetType": "blogpost"
# },
# "anonymousAccess": false,
# "unlicensedAccess": false
# }
# ],
# "settings": {
# "routeOverrideEnabled": true,
# "_links": {}
# },
# "theme": {},
# "lookAndFeel": {
# "headings": {
# "color": "<string>"
# },
# "links": {
# "color": "<string>"
# },
# "menus": {
# "hoverOrFocus": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "color": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "header": {
# "backgroundColor": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "button": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "primaryNavigation": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "secondaryNavigation": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "search": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "content": {
# "screen": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "container": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "header": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "body": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "bordersAndDividers": {
# "color": "<string>"
# }
# },
# "history": {
# "createdDate": "2004-03-14T14:56:20.738Z"
# }
# }
# },
# {
# "type": "user",
# "accountId": "aliquip ex aute occaecat minim",
# "accountType": "cupidatat dolore",
# "email": "tempor non",
# "publicName": "Lorem",
# "profilePicture": {
# "path": "fugiat ex sit sunt",
# "width": 86996840,
# "height": -45552232,
# "isDefault": false
# },
# "displayName": "eu qui mollit",
# "_expandable": {
# "operations": "laborum dolor magna adipisicing",
# "details": "culpa quis a",
# "personalSpace": "id in"
# },
# "_links": {},
# "username": "proident minim et ipsum",
# "userKey": "est conseq",
# "operations": [
# {
# "operation": "copy",
# "targetType": "comment"
# },
# {
# "operation": "purge_version",
# "targetType": "application"
# }
# ],
# "details": {
# "business": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "personal": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "personalSpace": {
# "id": -77236660,
# "key": "mollit",
# "name": "mollit reprehenderit",
# "type": "ipsum eu",
# "status": "id magna esse",
# "_expandable": {
# "settings": "Lorem cupidatat fugiat id",
# "metadata": "ut non",
# "operations": "m",
# "lookAndFeel": "elit ",
# "permissions": "proident labore",
# "icon": "ut fugiat esse do",
# "description": "sunt",
# "theme": "ea consequat aliqua",
# "history": "ullamco culpa",
# "homepage": "eu esse ut amet"
# },
# "_links": {},
# "icon": {
# "path": "laborum magna Dui",
# "width": -87940522,
# "height": -74576861,
# "isDefault": true
# },
# "description": {
# "plain": {
# "value": "adipisicing proident magna nulla",
# "representation": "view",
# "embeddedContent": [
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# ]
# },
# "view": {
# "value": "quis enim ex adipisicing",
# "representation": "plain",
# "embeddedContent": [
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# ]
# }
# },
# "homepage": {
# "value": "<Circular reference to #/components/schemas/Content detected>"
# },
# "metadata": {
# "labels": {
# "results": [
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# ],
# "start": 12150462,
# "limit": -13231996,
# "size": -79881326,
# "_links": {}
# }
# },
# "operations": [
# {
# "operation": "create",
# "targetType": "page"
# },
# {
# "operation": "update",
# "targetType": "blogpost"
# }
# ],
# "permissions": [
# {
# "subjects": {
# "_expandable": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "user": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "group": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "operation": {
# "operation": "purge",
# "targetType": "attachment"
# },
# "anonymousAccess": false,
# "unlicensedAccess": false
# },
# {
# "subjects": {
# "_expandable": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "user": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "group": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "operation": {
# "operation": "delete",
# "targetType": "application"
# },
# "anonymousAccess": false,
# "unlicensedAccess": false
# }
# ],
# "settings": {
# "routeOverrideEnabled": true,
# "_links": {}
# },
# "theme": {},
# "lookAndFeel": {
# "headings": {
# "color": "<string>"
# },
# "links": {
# "color": "<string>"
# },
# "menus": {
# "hoverOrFocus": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "color": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "header": {
# "backgroundColor": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "button": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "primaryNavigation": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "secondaryNavigation": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "search": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "content": {
# "screen": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "container": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "header": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "body": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# }
# },
# "bordersAndDividers": {
# "color": "<string>"
# }
# },
# "history": {
# "createdDate": "1965-11-18T11:33:14.736Z"
# }
# }
# }
# ],
# "start": -77819495,
# "limit": -88196390,
# "size": -80415169,
# "_links": {}
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set start [CkJsonObject_IntOf $jResp "start"]
set limit [CkJsonObject_IntOf $jResp "limit"]
set size [CkJsonObject_IntOf $jResp "size"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "results"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set v_type [CkJsonObject_stringOf $jResp "results[i].type"]
set accountId [CkJsonObject_stringOf $jResp "results[i].accountId"]
set accountType [CkJsonObject_stringOf $jResp "results[i].accountType"]
set email [CkJsonObject_stringOf $jResp "results[i].email"]
set publicName [CkJsonObject_stringOf $jResp "results[i].publicName"]
set Path [CkJsonObject_stringOf $jResp "results[i].profilePicture.path"]
set Width [CkJsonObject_IntOf $jResp "results[i].profilePicture.width"]
set Height [CkJsonObject_IntOf $jResp "results[i].profilePicture.height"]
set IsDefault [CkJsonObject_BoolOf $jResp "results[i].profilePicture.isDefault"]
set displayName [CkJsonObject_stringOf $jResp "results[i].displayName"]
set Operations [CkJsonObject_stringOf $jResp "results[i]._expandable.operations"]
set Details [CkJsonObject_stringOf $jResp "results[i]._expandable.details"]
set PersonalSpace [CkJsonObject_stringOf $jResp "results[i]._expandable.personalSpace"]
set username [CkJsonObject_stringOf $jResp "results[i].username"]
set userKey [CkJsonObject_stringOf $jResp "results[i].userKey"]
set Value [CkJsonObject_stringOf $jResp "results[i].details.business.value"]
set PersonalValue [CkJsonObject_stringOf $jResp "results[i].details.personal.value"]
set Id [CkJsonObject_IntOf $jResp "results[i].personalSpace.id"]
set Key [CkJsonObject_stringOf $jResp "results[i].personalSpace.key"]
set Name [CkJsonObject_stringOf $jResp "results[i].personalSpace.name"]
set v_Type [CkJsonObject_stringOf $jResp "results[i].personalSpace.type"]
set Status [CkJsonObject_stringOf $jResp "results[i].personalSpace.status"]
set Settings [CkJsonObject_stringOf $jResp "results[i].personalSpace._expandable.settings"]
set Metadata [CkJsonObject_stringOf $jResp "results[i].personalSpace._expandable.metadata"]
set v_expandableOperations [CkJsonObject_stringOf $jResp "results[i].personalSpace._expandable.operations"]
set LookAndFeel [CkJsonObject_stringOf $jResp "results[i].personalSpace._expandable.lookAndFeel"]
set Permissions [CkJsonObject_stringOf $jResp "results[i].personalSpace._expandable.permissions"]
set Icon [CkJsonObject_stringOf $jResp "results[i].personalSpace._expandable.icon"]
set Description [CkJsonObject_stringOf $jResp "results[i].personalSpace._expandable.description"]
set Theme [CkJsonObject_stringOf $jResp "results[i].personalSpace._expandable.theme"]
set History [CkJsonObject_stringOf $jResp "results[i].personalSpace._expandable.history"]
set Homepage [CkJsonObject_stringOf $jResp "results[i].personalSpace._expandable.homepage"]
set IconPath [CkJsonObject_stringOf $jResp "results[i].personalSpace.icon.path"]
set IconWidth [CkJsonObject_IntOf $jResp "results[i].personalSpace.icon.width"]
set IconHeight [CkJsonObject_IntOf $jResp "results[i].personalSpace.icon.height"]
set IconIsDefault [CkJsonObject_BoolOf $jResp "results[i].personalSpace.icon.isDefault"]
set PlainValue [CkJsonObject_stringOf $jResp "results[i].personalSpace.description.plain.value"]
set Representation [CkJsonObject_stringOf $jResp "results[i].personalSpace.description.plain.representation"]
set ViewValue [CkJsonObject_stringOf $jResp "results[i].personalSpace.description.view.value"]
set ViewRepresentation [CkJsonObject_stringOf $jResp "results[i].personalSpace.description.view.representation"]
set HomepageValue [CkJsonObject_stringOf $jResp "results[i].personalSpace.homepage.value"]
set Start [CkJsonObject_IntOf $jResp "results[i].personalSpace.metadata.labels.start"]
set Limit [CkJsonObject_IntOf $jResp "results[i].personalSpace.metadata.labels.limit"]
set Size [CkJsonObject_IntOf $jResp "results[i].personalSpace.metadata.labels.size"]
set RouteOverrideEnabled [CkJsonObject_BoolOf $jResp "results[i].personalSpace.settings.routeOverrideEnabled"]
set Color [CkJsonObject_stringOf $jResp "results[i].personalSpace.lookAndFeel.headings.color"]
set LinksColor [CkJsonObject_stringOf $jResp "results[i].personalSpace.lookAndFeel.links.color"]
set HoverOrFocusValue [CkJsonObject_stringOf $jResp "results[i].personalSpace.lookAndFeel.menus.hoverOrFocus.value"]
set ColorValue [CkJsonObject_stringOf $jResp "results[i].personalSpace.lookAndFeel.menus.color.value"]
set BackgroundColorValue [CkJsonObject_stringOf $jResp "results[i].personalSpace.lookAndFeel.header.backgroundColor.value"]
set ButtonValue [CkJsonObject_stringOf $jResp "results[i].personalSpace.lookAndFeel.header.button.value"]
set PrimaryNavigationValue [CkJsonObject_stringOf $jResp "results[i].personalSpace.lookAndFeel.header.primaryNavigation.value"]
set SecondaryNavigationValue [CkJsonObject_stringOf $jResp "results[i].personalSpace.lookAndFeel.header.secondaryNavigation.value"]
set SearchValue [CkJsonObject_stringOf $jResp "results[i].personalSpace.lookAndFeel.header.search.value"]
set ScreenValue [CkJsonObject_stringOf $jResp "results[i].personalSpace.lookAndFeel.content.screen.value"]
set ContainerValue [CkJsonObject_stringOf $jResp "results[i].personalSpace.lookAndFeel.content.container.value"]
set HeaderValue [CkJsonObject_stringOf $jResp "results[i].personalSpace.lookAndFeel.content.header.value"]
set BodyValue [CkJsonObject_stringOf $jResp "results[i].personalSpace.lookAndFeel.content.body.value"]
set BordersAndDividersColor [CkJsonObject_stringOf $jResp "results[i].personalSpace.lookAndFeel.bordersAndDividers.color"]
set CreatedDate [CkJsonObject_stringOf $jResp "results[i].personalSpace.history.createdDate"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "results[i].operations"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set operation [CkJsonObject_stringOf $jResp "results[i].operations[j].operation"]
set targetType [CkJsonObject_stringOf $jResp "results[i].operations[j].targetType"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "results[i].personalSpace.description.plain.embeddedContent"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set value [CkJsonObject_stringOf $jResp "results[i].personalSpace.description.plain.embeddedContent[j].value"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "results[i].personalSpace.description.view.embeddedContent"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set value [CkJsonObject_stringOf $jResp "results[i].personalSpace.description.view.embeddedContent[j].value"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "results[i].personalSpace.metadata.labels.results"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set value [CkJsonObject_stringOf $jResp "results[i].personalSpace.metadata.labels.results[j].value"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "results[i].personalSpace.operations"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set operation [CkJsonObject_stringOf $jResp "results[i].personalSpace.operations[j].operation"]
set targetType [CkJsonObject_stringOf $jResp "results[i].personalSpace.operations[j].targetType"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "results[i].personalSpace.permissions"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set v_expandableValue [CkJsonObject_stringOf $jResp "results[i].personalSpace.permissions[j].subjects._expandable.value"]
set UserValue [CkJsonObject_stringOf $jResp "results[i].personalSpace.permissions[j].subjects.user.value"]
set GroupValue [CkJsonObject_stringOf $jResp "results[i].personalSpace.permissions[j].subjects.group.value"]
set Operation [CkJsonObject_stringOf $jResp "results[i].personalSpace.permissions[j].operation.operation"]
set TargetType [CkJsonObject_stringOf $jResp "results[i].personalSpace.permissions[j].operation.targetType"]
set anonymousAccess [CkJsonObject_BoolOf $jResp "results[i].personalSpace.permissions[j].anonymousAccess"]
set unlicensedAccess [CkJsonObject_BoolOf $jResp "results[i].personalSpace.permissions[j].unlicensedAccess"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -G -d "accountId=%3Cstring%3E"
-d "expand=%3Cstring%3E"
-d "expand=%3Cstring%3E"
-d "limit=%3Cinteger%3E"
-H "Authorization: Bearer <access_token>"
https://your-domain.atlassian.net/wiki/rest/api/user/bulk
Postman Collection Item JSON
{
"name": "Get multiple users using ids",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/user/bulk?accountId=<string>&expand=<string>&expand=<string>&limit=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user",
"bulk"
],
"query": [
{
"key": "accountId",
"value": "<string>",
"description": "(Required) A list of accountId's of users to be returned."
},
{
"key": "expand",
"value": "<string>",
"description": "A multi-value parameter indicating which properties of the user to\nexpand.\n\n - `operations` returns the operations that the user is allowed to do.\n - `details.personal` returns the 'Personal' details in the user's profile, like the 'Email' and 'Phone'.\n Note that these fields have been deprecated due to privacy changes. See the\n [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\n for details.\n - `details.business` returns the 'Company' details in the user's profile, like the 'Position' and 'Department'.\n Note that these fields have been deprecated due to privacy changes. See the\n [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\n for details.\n - personalSpace returns the user's personal space, if it exists."
},
{
"key": "expand",
"value": "<string>",
"description": "A multi-value parameter indicating which properties of the user to\nexpand.\n\n - `operations` returns the operations that the user is allowed to do.\n - `details.personal` returns the 'Personal' details in the user's profile, like the 'Email' and 'Phone'.\n Note that these fields have been deprecated due to privacy changes. See the\n [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\n for details.\n - `details.business` returns the 'Company' details in the user's profile, like the 'Position' and 'Department'.\n Note that these fields have been deprecated due to privacy changes. See the\n [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\n for details.\n - personalSpace returns the user's personal space, if it exists."
},
{
"key": "limit",
"value": "<integer>",
"description": "The maximum number of results returned.\nCurrently API returns 200 results max.\nIf more that 200 ids are passed first 200 will be returned."
}
]
},
"description": "Returns user details for the ids provided in request.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission)."
},
"response": [
{
"name": "Returned if, the list of users is returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/api/user/bulk?accountId=<string>&expand=<string>&expand=<string>&limit=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user",
"bulk"
],
"query": [
{
"key": "accountId",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "limit",
"value": "<integer>"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"results\": [\n {\n \"type\": \"user\",\n \"accountId\": \"elit est ullamco in officia\",\n \"accountType\": \"exercitation fugiat labo\",\n \"email\": \"Excepteur in cillum officia\",\n \"publicName\": \"ullamco occaecat\",\n \"profilePicture\": {\n \"path\": \"cupidatat dolore et labore ad\",\n \"width\": -99848841,\n \"height\": 55035562,\n \"isDefault\": true\n },\n \"displayName\": \"amet\",\n \"_expandable\": {\n \"operations\": \"labore ut Duis id culpa\",\n \"details\": \"in irure voluptate Duis magna\",\n \"personalSpace\": \"n\"\n },\n \"_links\": {},\n \"username\": \"est sunt dolor nostrud\",\n \"userKey\": \"labo\",\n \"operations\": [\n {\n \"operation\": \"update\",\n \"targetType\": \"attachment\"\n },\n {\n \"operation\": \"administer\",\n \"targetType\": \"attachment\"\n }\n ],\n \"details\": {\n \"business\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"personal\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"personalSpace\": {\n \"id\": -93610124,\n \"key\": \"in eiusmod\",\n \"name\": \"ut minim Excepteur\",\n \"type\": \"sunt qui amet\",\n \"status\": \"null\",\n \"_expandable\": {\n \"settings\": \"pariatur deserunt anim\",\n \"metadata\": \"anim occaecat aliqua\",\n \"operations\": \"aute nostrud in\",\n \"lookAndFeel\": \"est irure aute labore\",\n \"permissions\": \"in cupidatat qui\",\n \"icon\": \"voluptate Duis\",\n \"description\": \"culpa veniam Lorem velit\",\n \"theme\": \"consequat sunt reprehenderit\",\n \"history\": \"ex officia veniam sit do\",\n \"homepage\": \"dolore dolore\"\n },\n \"_links\": {},\n \"icon\": {\n \"path\": \"dolore Lorem magna sunt\",\n \"width\": 3933679,\n \"height\": -17426468,\n \"isDefault\": false\n },\n \"description\": {\n \"plain\": {\n \"value\": \"consequat consectetur laborum labore occaecat\",\n \"representation\": \"view\",\n \"embeddedContent\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ]\n },\n \"view\": {\n \"value\": \"Duis reprehenderit anim ut\",\n \"representation\": \"view\",\n \"embeddedContent\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ]\n }\n },\n \"homepage\": {\n \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n },\n \"metadata\": {\n \"labels\": {\n \"results\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ],\n \"start\": 23981894,\n \"limit\": -68365223,\n \"size\": -97521792,\n \"_links\": {}\n }\n },\n \"operations\": [\n {\n \"operation\": \"administer\",\n \"targetType\": \"blogpost\"\n },\n {\n \"operation\": \"delete\",\n \"targetType\": \"blogpost\"\n }\n ],\n \"permissions\": [\n {\n \"subjects\": {\n \"_expandable\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"user\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"group\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"operation\": {\n \"operation\": \"read\",\n \"targetType\": \"space\"\n },\n \"anonymousAccess\": false,\n \"unlicensedAccess\": false\n },\n {\n \"subjects\": {\n \"_expandable\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"user\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"group\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"operation\": {\n \"operation\": \"restore\",\n \"targetType\": \"blogpost\"\n },\n \"anonymousAccess\": false,\n \"unlicensedAccess\": false\n }\n ],\n \"settings\": {\n \"routeOverrideEnabled\": true,\n \"_links\": {}\n },\n \"theme\": {},\n \"lookAndFeel\": {\n \"headings\": {\n \"color\": \"<string>\"\n },\n \"links\": {\n \"color\": \"<string>\"\n },\n \"menus\": {\n \"hoverOrFocus\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"color\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"header\": {\n \"backgroundColor\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"button\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"primaryNavigation\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"secondaryNavigation\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"search\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"content\": {\n \"screen\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"container\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"header\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"body\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"bordersAndDividers\": {\n \"color\": \"<string>\"\n }\n },\n \"history\": {\n \"createdDate\": \"2004-03-14T14:56:20.738Z\"\n }\n }\n },\n {\n \"type\": \"user\",\n \"accountId\": \"aliquip ex aute occaecat minim\",\n \"accountType\": \"cupidatat dolore\",\n \"email\": \"tempor non\",\n \"publicName\": \"Lorem\",\n \"profilePicture\": {\n \"path\": \"fugiat ex sit sunt\",\n \"width\": 86996840,\n \"height\": -45552232,\n \"isDefault\": false\n },\n \"displayName\": \"eu qui mollit\",\n \"_expandable\": {\n \"operations\": \"laborum dolor magna adipisicing\",\n \"details\": \"culpa quis a\",\n \"personalSpace\": \"id in\"\n },\n \"_links\": {},\n \"username\": \"proident minim et ipsum\",\n \"userKey\": \"est conseq\",\n \"operations\": [\n {\n \"operation\": \"copy\",\n \"targetType\": \"comment\"\n },\n {\n \"operation\": \"purge_version\",\n \"targetType\": \"application\"\n }\n ],\n \"details\": {\n \"business\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"personal\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"personalSpace\": {\n \"id\": -77236660,\n \"key\": \"mollit\",\n \"name\": \"mollit reprehenderit\",\n \"type\": \"ipsum eu\",\n \"status\": \"id magna esse\",\n \"_expandable\": {\n \"settings\": \"Lorem cupidatat fugiat id\",\n \"metadata\": \"ut non\",\n \"operations\": \"m\",\n \"lookAndFeel\": \"elit \",\n \"permissions\": \"proident labore\",\n \"icon\": \"ut fugiat esse do\",\n \"description\": \"sunt\",\n \"theme\": \"ea consequat aliqua\",\n \"history\": \"ullamco culpa\",\n \"homepage\": \"eu esse ut amet\"\n },\n \"_links\": {},\n \"icon\": {\n \"path\": \"laborum magna Dui\",\n \"width\": -87940522,\n \"height\": -74576861,\n \"isDefault\": true\n },\n \"description\": {\n \"plain\": {\n \"value\": \"adipisicing proident magna nulla\",\n \"representation\": \"view\",\n \"embeddedContent\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ]\n },\n \"view\": {\n \"value\": \"quis enim ex adipisicing\",\n \"representation\": \"plain\",\n \"embeddedContent\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ]\n }\n },\n \"homepage\": {\n \"value\": \"<Circular reference to #/components/schemas/Content detected>\"\n },\n \"metadata\": {\n \"labels\": {\n \"results\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ],\n \"start\": 12150462,\n \"limit\": -13231996,\n \"size\": -79881326,\n \"_links\": {}\n }\n },\n \"operations\": [\n {\n \"operation\": \"create\",\n \"targetType\": \"page\"\n },\n {\n \"operation\": \"update\",\n \"targetType\": \"blogpost\"\n }\n ],\n \"permissions\": [\n {\n \"subjects\": {\n \"_expandable\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"user\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"group\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"operation\": {\n \"operation\": \"purge\",\n \"targetType\": \"attachment\"\n },\n \"anonymousAccess\": false,\n \"unlicensedAccess\": false\n },\n {\n \"subjects\": {\n \"_expandable\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"user\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"group\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"operation\": {\n \"operation\": \"delete\",\n \"targetType\": \"application\"\n },\n \"anonymousAccess\": false,\n \"unlicensedAccess\": false\n }\n ],\n \"settings\": {\n \"routeOverrideEnabled\": true,\n \"_links\": {}\n },\n \"theme\": {},\n \"lookAndFeel\": {\n \"headings\": {\n \"color\": \"<string>\"\n },\n \"links\": {\n \"color\": \"<string>\"\n },\n \"menus\": {\n \"hoverOrFocus\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"color\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"header\": {\n \"backgroundColor\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"button\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"primaryNavigation\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"secondaryNavigation\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"search\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"content\": {\n \"screen\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"container\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"header\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"body\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"bordersAndDividers\": {\n \"color\": \"<string>\"\n }\n },\n \"history\": {\n \"createdDate\": \"1965-11-18T11:33:14.736Z\"\n }\n }\n }\n ],\n \"start\": -77819495,\n \"limit\": -88196390,\n \"size\": -80415169,\n \"_links\": {}\n}"
},
{
"name": "Returned if the calling user does not have permission to use\nConfluence.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": {
"content": "Added as a part of security scheme: oauth2",
"type": "text/plain"
},
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/api/user/bulk?accountId=<string>&expand=<string>&expand=<string>&limit=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"user",
"bulk"
],
"query": [
{
"key": "accountId",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "expand",
"value": "<string>"
},
{
"key": "limit",
"value": "<integer>"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
